AUauthlete
Authorization Endpoint

Fail Authorization Request

Changed on

This API generates a content of an error authorization response that the authorization server implementation returns to the client application.

post/api/{serviceId}/auth/authorization/fail

Request

  • Base URL
    https://us.authlete.com
  • URL
    https://us.authlete.com/api/{serviceId}/auth/authorization/fail
  • Auth
    HTTP bearer

Path parameters

serviceIdstring required

A service ID.

Request body

ticketstring required

The ticket issued from Authlete /auth/authorization API.

reason'UNKNOWN' | 'NOT_LOGGED_IN' | 'MAX_AGE_NOT_SUPPORTED' | 'EXCEEDS_MAX_AGE' | 'DIFFERENT_SUBJECT' | 'ACR_NOT_SATISFIED' | 'DENIED' | 'SERVER_ERROR' | 'NOT_AUTHENTICATED' | 'ACCOUNT_SELECTION_REQUIRED' | 'CONSENT_REQUIRED' | 'INTERACTION_REQUIRED' | 'INVALID_TARGET' | 'TEMPORARILY_UNAVAILABLE' | 'INVALID_SCOPE' | 'UNAUTHORIZED_CLIENT' required

The reason of the failure of the authorization request. For more details, see [NO_INTERACTION] in the description of /auth/authorization API.

descriptionstring

The custom description about the authorization failure.

Response

resultCodestring

The code which represents the result of the API call.

resultMessagestring

A short message which explains the result of the API call.

action'INTERNAL_SERVER_ERROR' | 'BAD_REQUEST' | 'LOCATION' | 'FORM'

The next action that the authorization server implementation should take.

responseContentstring

The content that the authorization server implementation is to return to the client application. Its format varies depending on the value of action parameter.

Changes

  • bc25340fc023Revision changes
    • info

      added the new INVALID_SCOPE enum value to the request property (media type: application/json)

    • info

      added the new INVALID_SCOPE enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new TEMPORARILY_UNAVAILABLE enum value to the request property (media type: application/json)

    • info

      added the new TEMPORARILY_UNAVAILABLE enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new UNAUTHORIZED_CLIENT enum value to the request property (media type: application/json)

    • info

      added the new UNAUTHORIZED_CLIENT enum value to the request property (media type: application/x-www-form-urlencoded)

  • 7ad74ab64749Revision changes
    • info

      added the non-success response with the status