Authlete
JwksRequestHandler Class Reference

Handler for requests to an endpoint that exposes JSON Web Key Set document (RFC 7517). More...

Inheritance diagram for JwksRequestHandler:
BaseRequestHandler

Public Member Functions

 JwksRequestHandler (IAuthleteApi api)
 Constructor. More...
 
async Task< HttpResponseMessage > Handle ()
 Handle a request to a JWK Set document endpoint. This method is an alias of Handle(true). More...
 
async Task< HttpResponseMessage > Handle (bool pretty)
 Handle a request to a JWK Set document endpoint. This method calls Authlete's /api/service/jwks/get 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 requests to an endpoint that exposes JSON Web Key Set document (RFC 7517).

An OpenID Provider (OP) is required to expose its JSON Web Key Set document (JWK Set) so that client applications can (1) verify signatures by the OP and (2) encrypt their requests to the OP. The URI of a JWK Set endpoint can be found as the value of the "jwks_uri" metadata which is defined in OpenID Provider Metadata, if the OP supports OpenID Connect Discovery 1.0.

Constructor & Destructor Documentation

◆ JwksRequestHandler()

Constructor.

Parameters
apiAn implementation of the IAuthleteApi interface.

Member Function Documentation

◆ Handle() [1/2]

async Task<HttpResponseMessage> Handle ( )
inline

Handle a request to a JWK Set document endpoint. This method is an alias of Handle(true).

Returns
An HTTP response that should be returned from the JWK Set document endpoint implementation to the client application.
Exceptions
AuthleteApiException

◆ Handle() [2/2]

async Task<HttpResponseMessage> Handle ( bool  pretty)
inline

Handle a request to a JWK Set document endpoint. This method calls Authlete's /api/service/jwks/get API.

Returns
An HTTP response that should be returned from the JWK Set document endpoint implementation to the client application.
Parameters
prettytrue to format the JWK Set document in a more human-readable way.
Exceptions
AuthleteApiException

The documentation for this class was generated from the following file: