Response from Authlete's /api/device/complete API.
More...
Properties | |
| DeviceCompleteAction | Action [get, set] |
| The next action that the authorization server implementation should take. 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/device/complete API.
Authlete's /api/device/complete 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 DeviceCompleteAction.SUCCESS, it means that the API call has been processed successfully. The authorization server should return a successful response to the web browser the end-user is using.
When the value of the Action property is DeviceCompleteAction.INVALID_REQUEST, it means that the API call is invalid. Probably, the authorization server implementation has some bugs.
When the value of the Action property is DeviceCompleteAction.USER_CODE_EXPIRED, it means that the user code included in the API call has expired. The authorization server implementation should tell the end-user that the user code has expired and urge her to re-initiate a device flow.
When the value of the Action property is DeviceCompleteAction.USER_CODE_NOT_EXIST, it means that the user code included in the API call does not exist. The authorization server implementation should tell the end-user that the user code has been invalidated and urge her to re-initiate a device flow.
When the value of the Action property is DeviceCompleteAction.SERVER_ERROR, it means that an error occurred on Authlete side. The authorization server implementation should tell the end-user that something wrong happened and urge her to re-initiate a device flow.
Since version 1.5.0.
Property Documentation
◆ Action
|
getset |
The next action that the authorization server implementation should take.
The documentation for this class was generated from the following file:
- Authlete/Dto/DeviceCompleteResponse.cs
