Process Device Authorization Request
This API parses request parameters of a device authorization request and returns necessary data for the authorization server implementation to process the device authorization request further.
Path parameters
A service ID.
Request body
Parameters of a device authorization request which are the request parameters that the device authorization endpoint of the authorization server implementation received from the client application.
The value of parameters is the entire entity body (which is formatted in application/x-www-form-urlencoded) of the request from the client application.
The client ID extracted from Authorization header of the device authorization request from the client application.
If the device authorization endpoint of the authorization server implementation supports Basic Authentication as a means of client authentication, and the request from the client application contained its client ID in Authorization header, the value should be extracted and set to this parameter.
The client secret extracted from Authorization header of the device authorization request from the client application.
If the device authorization endpoint of the authorization server implementation supports Basic Authentication as a means of client authentication, and the request from the client application contained its client secret in Authorization header, the value should be extracted and set to this parameter.
The client certificate used in the TLS connection between the client application and the device authorization endpoint of the authorization server.
The client certificate path presented by the client during client authentication. Each element is a string in PEM format.
The value of the OAuth-Client-Attestation HTTP header, which is defined in the specification of OAuth 2.0 Attestation-Based Client Authentication.
The value of the OAuth-Client-Attestation-PoP HTTP header, which is defined in the specification of OAuth 2.0 Attestation-Based Client Authentication.
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 client ID of the client application that has made the device authorization request.
The client ID alias of the client application that has made the device authorization request.
true if the value of the client_id request parameter included in the device authorization 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 device authorization request.
The client authentication method that should be performed at the device authorization endpoint.
The names of the claims which were requested indirectly via some special scopes. See 5.4. Requesting Claims using Scope Values in OpenID Connect Core 1.0 for details.
The list of ACR values requested by the device authorization request.
Basically, this property holds the value of the acr_values request parameter in the device authorization request. However, because unsupported ACR values are dropped on Authlete side, if the acr_values request parameter contains unrecognized ACR values, the list returned by this property becomes different from the value of the acr_values request parameter.
The device verification code. This corresponds to the device_code property in the response to the client.
The end-user verification code. This corresponds to the user_code property in the response to the client.
The end-user verification URI. This corresponds to the verification_uri property in the response to the client.
The end-user verification URI that includes the end-user verification code. This corresponds to the verification_uri_complete property in the response to the client.
The duration of the device verification code in seconds. This corresponds to the expires_in property in the response to the client.
The minimum amount of time in seconds that the client must wait for between polling requests to the token endpoint. This corresponds to the interval property in the response to the client.
The warnings raised during processing the backchannel authentication request.
The resources specified by the resource request parameters. See "Resource Indicators for OAuth 2.0" for details.
The grant management action of the device authorization request.
The grant_management_action request parameter is defined in Grant Management for OAuth 2.0.
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 subject identifying the user who has given the grant identified by the grant_id request parameter of the device authorization request. Authlete 2.3 and newer versions support Grant Management for OAuth 2.0. An authorization request may contain a grant_id request parameter which is defined in the specification. If the value of the request parameter is valid, {@link #getGrantSubject()} will return the subject of the user who has given the grant to the client application. Authorization server implementations may use the value returned from {@link #getGrantSubject()} in order to determine the user to authenticate. The user your system will authenticate during the authorization process (or has already authenticated) may be different from the user of the grant. The first implementer's draft of "Grant Management for OAuth 2.0" does not mention anything about the case, so the behavior in the case is left to implementations. Authlete will not perform the grant management action when the subject passed to Authlete does not match the user of the grant.
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.