Response from Authlete's /api/pushed_auth_req API.
More...
Properties | |
| PushedAuthReqAction | Action [get, set] |
| The next action that the revocation endpoint should take. More... | |
| string | ResponseContent [get, set] |
| The response content which can be used as the entity body of the response returned to the client application. More... | |
| Uri | RequestUri [get, set] |
The request URI created to represent the pushed authorization request. When the client application sends an authorization request later, the value held by this property can be used as the value of the request_uri parameter. 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/pushed_auth_req API.
Authlete's /api/pushed_auth_req API returns JSON which can be mapped to this class. The authorization server implementation should retrieve the value of the "action" from the response and take the following steps according to the value.
When the value of the Action property is PushedAuthReqAction.CREATED, it means that the authorization request has been registered successfully.
The authorization server implementation should generate a response to the client application with 201 Created and application/json.
The ResponseContent property holds a JSON string which 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 PushedAuthReqAction.BAD_REQUEST, it means that the request was wrong.
The authorization server implementation should generate a response to the client application with 400 Bad Request 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 PushedAuthReqAction.UNAUTHORIZED, it means that client authentication of the request failed.
The authorization server implementation should generate a response to the client application with 401 Unauthorized 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 PushedAuthReqAction.FORBIDDEN, it means that the client application is not allowed to use the pushed authorization request endpoint.
The authorization server implementation should generate a response to the client application with 403 Forbidden 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 PushedAuthReqAction.PAYLOAD_TOO_LARGE, it means that the size of the pushed authorization request is too large.
The authorization server implementation should generate a response to the client application with 401 Payload Too Large 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 PushedAuthReqAction.INTERNAL_SERVER_ERROR, it means that the API call from the authorization server implementation was wrong or that an error occurred in Authlete.
In either case, from a viewpoint of the client application, it 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.
Since version 1.5.0.
Property Documentation
◆ Action
|
getset |
The next action that the revocation endpoint should take.
◆ RequestUri
|
getset |
The request URI created to represent the pushed authorization request. When the client application sends an authorization request later, the value held by this property can be used as the value of the request_uri parameter.
◆ ResponseContent
|
getset |
The response content which can be used as the entity body of the response returned to the client application.
The documentation for this class was generated from the following file:
- Authlete/Dto/PushedAuthReqResponse.cs
