AUauthlete
Federation Endpoint

Process Entity Configuration Request

Changed on

This API gathers the federation configuration about a service. The authorization server implementation should retrieve the value of the action response parameter from the API response and take the following steps according to the value.

post/api/{serviceId}/federation/configuration

Request

  • Base URL
    https://us.authlete.com
  • URL
    https://us.authlete.com/api/{serviceId}/federation/configuration
  • Auth
    HTTP bearer

Path parameters

serviceIdstring required

A service ID.

Request body

entityTypesEntityType[]

The entity types for which the entity configuration is requested. When omitted or empty, it defaults to OPENID_PROVIDER only (backward compatibility). Unsupported entity types are ignored. OPENID_CREDENTIAL_ISSUER requires the Verifiable Credentials feature (Authlete 3.0+).

Response

Federation configuration retrieved successfully

resultCodestring

The code which represents the result of the API call.

resultMessagestring

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

action'OK' | 'NOT_FOUND' | 'INTERNAL_SERVER_ERROR'

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

  • 7ad74ab64749Revision changes
    • breaking

      request body became required

    • info

      added the new optional request property

    • info

      added the non-success response with the status