Response from Authlete's /api/auth/token/update API.
More...
Properties | |
| TokenUpdateAction | Action [get, set] |
| The code which indicates how the response should be interpreted. More... | |
| string | AccessToken [get, set] |
The access token which was specified by the "accessToken" request parameter of the API call. More... | |
| string | TokenType [get, set] |
| The token type associated with the access token. More... | |
| long | AccessTokenExpiresAt [get, set] |
| The date at which the access token will expire. The value is expressed in milliseconds since the Unix epoch (1970-Jan-1). More... | |
| string[] | Scopes [get, set] |
| The scopes associated with the access token. More... | |
| Property[] | Properties [get, set] |
| The properties associated with the access token. 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/auth/token/update API.
Authlete's /api/auth/token/update API returns JSON which can be mapped to this class. The first step that a caller should take is to retrieve the value of the "action" response parameter (which can be obtained via the Action property) from the response.
When the value of the Action property is TokenUpdateAction.INTERNAL_SERVER_ERROR, it means that an error occurred on Authlete side.
When the value of the Action property is TokenUpdateAction.BAD_REQUEST, it means that the request from the caller was wrong. For example, this happens when the "accessToken" request parameter is missing.
When the value of the Action property is TokenUpdateAction.FORBIDDEN, it means that the request from the caller was not allowed. For example, this happens when the access token identified by the accessToken request parameter does not belong to the service identified by the API key used for the API call.
When the value of the Action property is TokenUpdateAction.NOT_FOUND, it means that the specified access token does not exist.
When the value of the Action property is TokenUpdateAction.OK, it means that the access token was updated successfully.
Property Documentation
◆ AccessToken
|
getset |
The access token which was specified by the "accessToken" request parameter of the API call.
◆ AccessTokenExpiresAt
|
getset |
The date at which the access token will expire. The value is expressed in milliseconds since the Unix epoch (1970-Jan-1).
◆ Action
|
getset |
The code which indicates how the response should be interpreted.
◆ Properties
|
getset |
The properties associated with the access token.
◆ Scopes
|
getset |
The scopes associated with the access token.
◆ TokenType
|
getset |
The token type associated with the access token.
Since version 1.3.0.
The documentation for this class was generated from the following file:
- Authlete/Dto/TokenUpdateResponse.cs
