Issue Authorization Response
This API parses request parameters of an authorization request and returns necessary data for the authorization server implementation to process the authorization request further.
Path parameters
A service ID.
Request body
The ticket issued from Authlete /auth/authorization API.
The subject (= a user account managed by the service) who has granted authorization to the client application.
The time when the authentication of the end-user occurred. Its value is the number of seconds from 1970-01-01.
The Authentication Context Class Reference performed for the end-user authentication.
The claims of the end-user (= pieces of information about the end-user) in JSON format. See OpenID Connect Core 1.0, 5.1. Standard Claims for details about the format.
Scopes to associate with an access token and/or an authorization code. If a non-empty string array is given, it replaces the scopes specified by the original authorization request.
The value of the sub claim to embed in an ID token. If this request parameter is null or empty, the value of the subject request parameter is used as the value of the sub claim.
JSON that represents additional JWS header parameters for ID tokens that may be issued based on the authorization request.
Claim key-value pairs that are used to compute transformed claims.
the claims that the user has consented for the client application to know.
Additional claims that are added to the payload part of the JWT access token.
The representation of an access token that may be issued as a result of the Authlete API call.
The duration (in seconds) of the access token that may be issued as a result of the Authlete API call.
When this request parameter holds a positive integer, it is used as the duration of the access token in. In other cases, this request parameter is ignored.
The session ID of the user's authentication session. The specified value will be embedded in the ID token as the value of the sid claim. This parameter needs to be provided only if you want to support the OpenID Connect Native SSO for Mobile Apps 1.0 specification (a.k.a. "Native SSO"). To enable support for the Native SSO specification, the nativeSsoSupported property of your service must be set to true.
The type of the aud claim of the ID token being issued. Valid values are as follows.
| Value | Description |
|---|---|
| "array" | The type of the aud claim is always an array of strings. |
| "string" | The type of the aud claim is always a single string. |
| null | The type of the aud claim remains the same as before. |
This request parameter takes precedence over the idTokenAudType property of the service.
Values of verified claims requested indirectly by "transformed claims".
Response
The code which represents the result of the API call.
A short message which explains the result of the API call.
The next action that the authorization server implementation should take.
The content that the authorization server implementation is to return to the client application. Its format varies depending on the value of action parameter.
The newly issued access token. Note that an access token is issued from an authorization endpoint only when response_type contains token.
The datetime at which the newly issued access token will expire. The value is represented in milliseconds since the Unix epoch (1970-01-01).
The duration of the newly issued access token in seconds.
The newly issued ID token. Note that an ID token is issued from an authorization endpoint only when response_type contains id_token.
The newly issued authorization code. Note that an authorization code is issued only when response_type contains code.
The newly issued access token in JWT format. If the service is not configured to issue JWT-based access tokens, this property is always set to null.