ConfigurationRequestHandler Class Reference

Handler for requests to a configuration endpoint. More...

Inheritance diagram for ConfigurationRequestHandler:

Public Member Functions
	ConfigurationRequestHandler (IAuthleteApi api)
	Constructor. More...
async Task< HttpResponseMessage >	Handle ()
	Handle a request to a configuration endpoint. This method is an alias of Handle(true). More...
async Task< HttpResponseMessage >	Handle (bool pretty)
	Handle a request to a configuration endpoint. This method calls Authlete's /api/service/configuration 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 a configuration endpoint.

An OpenID Provider that supports OpenID Connect Discovery 1.0 provides an endpoint that returns its configuration information in JSON format. Details about the format are described in 3. OpenID Provider Metadata of OpenID Connect Discovery 1.0.

Note that the URI of an OpenID Provider configuration endpoint is defined in 4.1. OpenID Provider Configuration Request. In short, the URI must be:

{Issuer-Identifier}/.well-known/openid-configuration

{Issuer-Identifier} is a URL to identify an OpenID Provider. For example, https://example.com. For details about Issuer Identifier, see the description about the "issuer" metadata defined in 3. OpenID Provider Metadata (OpenID Conect Discovery 1.0) and the "iss" claim in (2. ID Token (OpenID Connect Core 1.0).

You can change the Issuer Identifier of your service by using the management console (Service Owner Console). Note that the default value of Issuer Identifier is not appropriate for production use, so you should change it.

Constructor & Destructor Documentation

ConfigurationRequestHandler()

ConfigurationRequestHandler ( IAuthleteApi  api )

inline

Constructor.

Parameters

api	An implementation of the IAuthleteApi interface.

Member Function Documentation

Handle() [1/2]

async Task<HttpResponseMessage> Handle ( )

inline

Handle a request to a configuration endpoint. This method is an alias of Handle(true).

Returns

An HTTP response that should be returned from the configuration endpoint implementation to the client application.

Exceptions

AuthleteApiException

Handle() [2/2]

async Task<HttpResponseMessage> Handle ( bool  pretty )

inline

Handle a request to a configuration endpoint. This method calls Authlete's /api/service/configuration API.

Returns

An HTTP response that should be returned from the configuration endpoint implementation to the client application.

Parameters

pretty

true to format the output JSON in a more human-readable way.

Exceptions

AuthleteApiException

---

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

• Authlete/Handler/ConfigurationRequestHandler.cs