Authlete
Properties | List of all members
BackchannelAuthenticationFailRequest Class Reference

Request to Authlete's /api/backchannel/authentication/fail API. More...

Properties

string Ticket [get, set]
 The ticket which should be deleted on the API call. More...
 
BackchannelAuthenticationFailReason Reason [get, set]
 The reason of the failure of the backchannel authentication request. More...
 
string ErrorDescription [get, set]
 The description of the error. If this optional parameter is given, its value is used as the value of the error_description property in the response to the client application. More...
 
Uri ErrorUri [get, set]
 The URI of a document which describes the error in detail. If this optional request parameter is given, its value is used as the value of the error_uri property in the response to the client application. More...
 

Detailed Description

Request to Authlete's /api/backchannel/authentication/fail API.

The API prepares JSON that contains an error. The JSON should be used as the response body of the response which is returned to the client application from the backchannel authentication endpoint.

Since version 1.3.0.

Property Documentation

◆ ErrorDescription

string ErrorDescription
getset

The description of the error. If this optional parameter is given, its value is used as the value of the error_description property in the response to the client application.

◆ ErrorUri

Uri ErrorUri
getset

The URI of a document which describes the error in detail. If this optional request parameter is given, its value is used as the value of the error_uri property in the response to the client application.

◆ Reason

BackchannelAuthenticationFailReason Reason
getset

The reason of the failure of the backchannel authentication request.

This request parameter is not mandatory but optional. However, giving this parameter is recommended. If omitted, BackchannelAuthenticationFailReason.SERVER_ERROR is used as a reason.

◆ Ticket

string Ticket
getset

The ticket which should be deleted on the API call.

This request parameter is not mandatory but optional. If this request parameter is given and the ticket belongs to the service, the specified ticket is deleted from the database. Giving this parameter is recommended to clean up the storage area for the service.

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