AUauthlete
UserInfo Endpoint

Issue UserInfo Response

Changed on

This API generates an ID token.

post/api/{serviceId}/auth/userinfo/issue

Request

  • Base URL
    https://us.authlete.com
  • URL
    https://us.authlete.com/api/{serviceId}/auth/userinfo/issue
  • Auth
    HTTP bearer

Path parameters

serviceIdstring required

A service ID.

Request body

tokenstring required

The access token that has been passed to the userinfo endpoint by the client application. In other words, the access token which was contained in the userinfo request.

claimsstring

Claims in JSON format. As for the format, see OpenID Connect Core 1.0, 5.1. Standard Claims.

substring

The value of the sub claim. If the value of this request parameter is not empty, it is used as the value of the sub claim. Otherwise, the value of the subject associated with the access token is used.

claimsForTxstring

Claim key-value pairs that are used to compute transformed claims.

requestSignaturestring

The Signature header value from the request.

verifiedClaimsForTxstring[]

Values of verified claims requested indirectly by "transformed claims".

Response

User info issued successfully

resultCodestring

The code which represents the result of the API call.

resultMessagestring

A short message which explains the result of the API call.

action'INTERNAL_SERVER_ERROR' | 'BAD_REQUEST' | 'UNAUTHORIZED' | 'FORBIDDEN' | 'JSON' | 'JWT'

The next action that the authorization server implementation should take.

responseContentstring

The content that the authorization server implementation can use as the value of WWW-Authenticate header on errors.

signaturestring

The signature header of the response message.

signatureInputstring

The signature-input header of the response message

contentDigeststring

The content-digest header of the response message

Changes