RevocationRequestHandler Class Reference
Handler for revocation requests to a revocation endpoint (RFC 7009). More...
Inheritance diagram for RevocationRequestHandler:
Public Member Functions | |
| RevocationRequestHandler (IAuthleteApi api) | |
| Constructor. More... | |
| async Task< HttpResponseMessage > | Handle (string parameters, AuthenticationHeaderValue authorization) |
Handle a revocation request (RFC 7009). This method calls Authlete's /api/auth/revocation API. More... | |
| async Task< HttpResponseMessage > | Handle (string parameters, string authorizationHeaderValue) |
Handle a revocation request (RFC 7009). This method calls Authlete's /api/auth/revocation API. More... | |
| async Task< HttpResponseMessage > | Handle (string parameters, BasicCredentials credentials) |
Handle a revocation request (RFC 7009). This method calls Authlete's /api/auth/revocation API. More... | |
 Public Member Functions inherited from BaseRequestHandler | |
| BaseRequestHandler (IAuthleteApi api) | |
Constructor with an implementation of the IAuthleteApi interface. The given value can be referred to as the value of the Api property later. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from BaseRequestHandler | |
| HttpResponseMessage | UnknownAction (string apiPath) |
A utility method to generate an HttpResponseMessage instance with "500 Internal Server Error" and an error message in JSON. This method is expected to be used when the value of the "action" parameter in a response from an Authlete API holds an unexpected value. More... | |
| Properties inherited from BaseRequestHandler | |
| IAuthleteApi | Api [get] |
The implementation of the IAuthleteApi interface. It is the value given to the constructor. More... | |
Detailed Description
Handler for revocation requests to a revocation endpoint (RFC 7009).
Constructor & Destructor Documentation
◆ RevocationRequestHandler()
|
inline |
Constructor.
- Parameters
-
api An implementation of the IAuthleteApiinterface.
Member Function Documentation
◆ Handle() [1/3]
|
inline |
Handle a revocation request (RFC 7009). This method calls Authlete's /api/auth/revocation API.
- Returns
- An HTTP response that should be returned from the revocation endpoint implementation to the client application.
- Parameters
-
parameters Request parameters of a revocation request.
- Parameters
-
authorization The value of the Authorizationheader in the revocation request. A client application may embed its pair of client ID and client secret in a revocation request using Basic Authentication.
- Exceptions
-
AuthleteApiException
◆ Handle() [2/3]
|
inline |
Handle a revocation request (RFC 7009). This method calls Authlete's /api/auth/revocation API.
Since version 1.0.3
- Returns
- An HTTP response that should be returned from the revocation endpoint implementation to the client application.
- Parameters
-
parameters Request parameters of a revocation request.
- Parameters
-
credentials The pair of client ID and client secret that might be embedded in the Authorizationheader of the revocation request.
- Exceptions
-
AuthleteApiException
◆ Handle() [3/3]
|
inline |
Handle a revocation request (RFC 7009). This method calls Authlete's /api/auth/revocation API.
Since version 1.0.3
- Returns
- An HTTP response that should be returned from the revocation endpoint implementation to the client application.
- Parameters
-
parameters Request parameters of a revocation request.
- Parameters
-
authorizationHeaderValue The value of the Authorizationheader in the revocation request. A client application may embed its pair of client ID and client secret in a revocation request using Basic Authentication.
- Exceptions
-
AuthleteApiException
The documentation for this class was generated from the following file:
- Authlete/Handler/RevocationRequestHandler.cs
