Sign in

v16

OpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-04-0886158866.0 KB
Federation Endpoint

Process Federation Registration Request

The Authlete API is for implementations of the federation registration endpoint that accepts "explicit client registration". Its details are defined in OpenID Connect Federation 1.0. The endpoint accepts POST requests whose Content-Type is either of the following.

  1. application/entity-statement+jwt- application/trust-chain+json When the Content-Type of a request is application/entity-statement+jwt, the content of the request is the entity configuration of a relying party that is to be registered. In this case, the implementation of the federation registration endpoint should call Authlete's /federation/registration API with the entity configuration set to the entityConfiguration request parameter. On the other hand, when the Content-Type of a request is application/trust-chain+json, the content of the request is a JSON array that contains entity statements in JWT format. The sequence of the entity statements composes the trust chain of a relying party that is to be registered. In this case, the implementation of the federation registration endpoint should call Authlete's /federation/registration API with the trust chain set to the trustChain request parameter.
post/api/{serviceId}/federation/registration

Path parameters

serviceIdstring required

A service ID.

Request body

entityConfigurationstring

The entity configuration of a relying party.

trustChainstring

The trust chain of a relying party.

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'OK' | 'BAD_REQUEST' | 'NOT_FOUND' | 'INTERNAL_SERVER_ERROR'

The next action that the authorization server implementation should take.

responseContentstring

The content that the authorization server implementation can use as the value of WWW-Authenticate header on errors.

Example response

{
  "client": {
    "number": 1140735077,
    "serviceNumber": 715948317,
    "clientName": "My Test Client",
    "clientId": "1140735077",
    "clientSecret": "gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ",
    "clientType": "PUBLIC",
    "redirectUris": [
      "https://example.com/callback"
    ],
    "responseTypes": [
      "CODE"
    ],
    "grantTypes": [
      "AUTHORIZATION_CODE"
    ]
  }
}