AuthorizationRequestBaseHandler Class Reference

The base class for request handlers that are used in the implementation of an authorization endpoint. More...

Inheritance diagram for AuthorizationRequestBaseHandler:

Public Member Functions
	AuthorizationRequestBaseHandler (IAuthleteApi api)
	Consturctor with an implementation of the IAuthleteApi interface which will be passed to the constructor of the super class. 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...

Protected Member Functions
async Task< HttpResponseMessage >	AuthorizationIssue (string ticket, string subject, long authTime, string acr, IDictionary< string, object > claims, Property[] properties, string[] scopes, string sub)
	Call Authlete's /api/auth/authorization/issue API and generate an HttpResponseMessage instance according to the value of the "action" parameter in the response from the API. Read the description of AuthorizationIssueRequest for details about the parameters given to this method. More...
async Task< HttpResponseMessage >	AuthorizationFail (string ticket, AuthorizationFailReason reason)
	Call Authlete's /api/auth/authorization/fail API and generate an HttpResponseMessage instance according to the value of the "action" parameter in the response from the API. Read the description of AuthorizationFailRequest for details about the parameters given to this method. More...
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...

Additional Inherited Members
Properties inherited from BaseRequestHandler
IAuthleteApi	Api [get]
	The implementation of the IAuthleteApi interface. It is the value given to the constructor. More...

Detailed Description

The base class for request handlers that are used in the implementation of an authorization endpoint.

Constructor & Destructor Documentation

AuthorizationRequestBaseHandler()

AuthorizationRequestBaseHandler ( IAuthleteApi  api )

inline

Consturctor with an implementation of the IAuthleteApi interface which will be passed to the constructor of the super class.

Parameters

api	An implementation of the IAuthleteApi interface.

Member Function Documentation

AuthorizationFail()

async Task<HttpResponseMessage> AuthorizationFail ( string  ticket, AuthorizationFailReason  reason  )

inlineprotected

Call Authlete's /api/auth/authorization/fail API and generate an HttpResponseMessage instance according to the value of the "action" parameter in the response from the API. Read the description of AuthorizationFailRequest for details about the parameters given to this method.

Returns

An HTTP response that should be returned from the authorization endpoint implementation to the user agent.

Parameters

ticket

The ticket which was issued from Authlete's /api/auth/authorization API.

Parameters

reason

The reason of the failure of the authorization request.

Exceptions

AuthleteApiException

AuthorizationIssue()

async Task<HttpResponseMessage> AuthorizationIssue ( string  ticket, string  subject, long  authTime, string  acr, IDictionary< string, object >  claims, Property[]  properties, string[]  scopes, string  sub  )

inlineprotected

Call Authlete's /api/auth/authorization/issue API and generate an HttpResponseMessage instance according to the value of the "action" parameter in the response from the API. Read the description of AuthorizationIssueRequest for details about the parameters given to this method.

Returns

An HTTP response that should be returned from the authorization endpoint implementation to the user agent.

Parameters

ticket

The ticket which was issued from Authlete's /api/auth/authorization API.

Parameters

subject

The subject (= unique identifier) of the end-user.

Parameters

authTime

The time at which the end-user was authenticated. The value should be seconds since the Unix epoch (1970-Jan-1).

Parameters

acr	The Authentication Context Class Reference performed for the end-user authentication.

Parameters

claims

The claims about the end-user.

Parameters

properties

Arbitrary properties to be associated with an access token and/or an authorization code.

Parameters

scopes

Scopes to be associated with an access token and/or an authorization code.

Parameters

sub	The value of the "sub" claim which is embedded in an ID token. If this argument is null, the value of 'subject' will be used instead.

Exceptions

AuthleteApiException

---

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

• Authlete/Handler/AuthorizationRequestBaseHandler.cs