Response from Authlete's /api/backchannel/authentication/issue API.
More...
Properties | |
| BackchannelAuthenticationIssueAction | Action [get, set] |
| The next action that the authorization server implementation should take. More... | |
| string | ResponseContent [get, set] |
| The content of the response body of the response to the client application. Its format is JSON. More... | |
| string | AuthReqId [get, set] |
The issued authentication request ID. This corresponds to the auth_req_id property in the response to the client application. More... | |
| int | ExpiresIn [get, set] |
The duration of the issued authentication request ID in seconds. This corresponds to the expires_in property in the response to the client application. More... | |
| int | Interval [get, set] |
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 application. More... | |
 Properties inherited from ApiResponse | |
| string | ResultCode [get, set] |
The code of the result of an Authlete API call. For example, "A004001". More... | |
| string | ResultMessage [get, set] |
| The message of the result of an Authlete API call. For example, "[A001202] /client/get/list,
Authorization header is missing." More... | |
Detailed Description
Response from Authlete's /api/backchannel/authentication/issue API.
Authlete's /api/backchannel/authentication/issue API returns JSON which can be mapped to this class. The authorization server implementation should retrieve the value of the action response parameter (which can be obtained via the Action property) from the response and take the following steps according to the value.
When the value of the Action property is BackchannelAuthenticationIssueAction.OK, it means that Authlete has succeeded in preparing JSON that contains an auth_req_id. The JSON should be used as the response body of the response which is returned to the client from the backchannel authentication endpoint. The ResponseContent property holds the JSON.
The following illustrates the response which the authorization server implementation should generate and return to the client application.
When the value of the Action property is BackchannelAuthenticationIssueAction.INTERNAL_SERVER_ERROR, it means that an error occurred in Authlete.
From a viewpoint of the client application, this is an error on the server side. Therefore, the authorization server implementation should generate a response to the client application with 500 Internal Server Error and application/json.
The ResponseContent property holds a JSON string which describes the error, so it can be used as the entity body of the response. The following illustrates the response which the authorization server implementation should generate and return to the client application.
When the value of the Action property is BackchannelAuthenticationIssueAction.INVALID_TICKET, it means that the ticket included in the API call was invalid. For example, it does not exist or has expired.
From a viewpoint of the client application, this is an error on the server side. Therefore, the authorization server implementation should generate a response to the client application with 500 Internal Server Error and application/json.
You can build an error response in the same way as shown in the description for the case of INTERNAL_SERVER_ERROR.
Since version 1.3.0.
Property Documentation
◆ Action
|
getset |
The next action that the authorization server implementation should take.
◆ AuthReqId
|
getset |
The issued authentication request ID. This corresponds to the auth_req_id property in the response to the client application.
◆ ExpiresIn
|
getset |
The duration of the issued authentication request ID in seconds. This corresponds to the expires_in property in the response to the client application.
◆ Interval
|
getset |
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 application.
The value held by this property has no meaning when the backchannel token delivery mode is "push".
◆ ResponseContent
|
getset |
The content of the response body of the response to the client application. Its format is JSON.
In successful cases, the content contains auth_req_id. In error cases, the content contains error.
The documentation for this class was generated from the following file:
- Authlete/Dto/BackchannelAuthenticationIssueResponse.cs
