UserInfo Endpoint

GET/openapi/v1/oauth/userinfo

Returns information about the user associated with the current access token. Follows the OpenID Connect UserInfo endpoint convention.

Useful for verifying which user and Space the token represents after completing the OAuth authorization flow.


Request Parameters

AuthorizationRequiredstring
Bearer <access_token>

Response Parameters

subOptionalstring
Subject — the user's unique ID within Tencent eSign.
space_idOptionalstring
The Space (tenant) the token is bound to.
app_idOptionalstring
The App ID that issued this token.
emailOptionalstring
The user's email address.
scopeOptionalstring
The scopes granted to this token.

Response Example

{
  "sub": "SG_1234567890",
  "space_id": "SGSPxQk2mN8pR4vW1yH3jT5bZ6aE7cF0",
  "app_id": "APxQk2mN8pR4vW1yH3jT5bZ6aE7cF0ab",
  "email": "user@example.com",
  "scope": "envelope:create envelope:read"
}

Error Codes

Error CodeDescription
invalid_tokenMissing or invalid access token.