Complete Backchannel Authentication
This API returns information about what action the authorization server should take after it receives the result of end-user's decision about whether the end-user has approved or rejected a client application's request on the authentication device.
Path parameters
A service ID.
Request body
The ticket issued by Authlete's /backchannel/authentication API.
The result of the end-user authentication and authorization. One of the following. Details are described in the description.
The subject (= unique identifier) of the end-user.
The value of the sub claim that should be used in the ID token.
The time at which the end-user was authenticated. Its value is the number of seconds from 1970-01-01.
The reference of the authentication context class which the end-user authentication satisfied.
Additional claims which will be embedded in the ID token.
Scopes to replace the scopes specified in the original backchannel authentication request with. When nothing is specified for this parameter, replacement is not performed.
JSON that represents additional JWS header parameters for ID tokens.
The description of the error. If this optional request parameter is given, its value is used as the value of the error_description property, but it is used only when the result is not AUTHORIZED. To comply with the specification strictly, the description must not include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
The URI of a document which describes the error in detail. This corresponds to the error_uri property in the response to the client.
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 duration (in seconds) of the refresh 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 refresh token in. In other cases, this request parameter is ignored.
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.
Response
Backchannel authentication completed successfully
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 client ID of the client application that has made the backchannel authentication request.
The client ID alias of the client application that has made the backchannel authentication request.
true if the value of the client_id request parameter included in the backchannel authentication request is the client ID alias. false if the value is the original numeric client ID.
The name of the client application which has made the backchannel authentication request.
The client notification endpoint to which a notification needs to be sent. This corresponds to the client_notification_endpoint metadata of the client application.
The client notification token which needs to be embedded as a Bearer token in the Authorization header in the notification. This is the value of the client_notification_token request parameter included in the backchannel authentication request.
The newly issued authentication request ID.
The issued access token.
The issued refresh token.
The issued ID token.
The duration of the access token in seconds.
The duration of the refresh token in seconds.
The duration of the ID token in seconds.
The issued access token in JWT format.
The resources specified by the resource request parameters or by the resource property in the request object. If both are given, the values in the request object should be set. See "Resource Indicators for OAuth 2.0" for details.
the value of the grant_id request parameter of the device authorization request.
The grant_id request parameter is defined in Grant Management for OAuth 2.0 , which is supported by Authlete 2.3 and newer versions.
The entity ID of the client.
Flag which indicates whether the entity ID of the client was used when the request for the access token was made.
The location of the client's metadata document that was used to resolve client metadata.
This property is set when client metadata was retrieved via the OAuth Client ID Metadata Document (CIMD) mechanism.
Flag indicating whether a metadata document was used to resolve client metadata for this request.
When true, the client metadata was retrieved via the CIMD mechanism rather than from the Authlete database.