Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

Authenticate every request with a Service Access Token or Organization Token. Set the token value in the Authorization: Bearer <token> header.

Service Access Token: Scoped to a single service. Use when automating service-level configuration or runtime flows.

Organization Token: Scoped to the organization; inherits permissions across services. Use for org-wide automation or when managing multiple services programmatically.

Both token types are issued by the Authlete console or provisioning APIs.

Path Parameters

serviceId
string
required

A service ID.

Body

token
string
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.

claims
string

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

sub
string

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.

claimsForTx
string

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

requestSignature
string

The Signature header value from the request.

headers
object[]

HTTP headers to be included in processing the signature. If this is a signed request, this must include the Signature and Signature-Input headers, as well as any additional headers covered by the signature.

verifiedClaimsForTx
string[]

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

Response

User info issued successfully

resultCode
string

The code which represents the result of the API call.

resultMessage
string

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

action
enum<string>

The next action that the authorization server implementation should take.

Available options:
INTERNAL_SERVER_ERROR,
BAD_REQUEST,
UNAUTHORIZED,
FORBIDDEN,
JSON,
JWT
responseContent
string

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

signature
string

The signature header of the response message.

signatureInput
string

The signature-input header of the response message

contentDigest
string

The content-digest header of the response message