Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

Authenticate every request with a Service Access Token or Organization Token. Set the token value in the Authorization: Bearer <token> header.

Service Access Token: Scoped to a single service. Use when automating service-level configuration or runtime flows.

Organization Token: Scoped to the organization; inherits permissions across services. Use for org-wide automation or when managing multiple services programmatically.

Both token types are issued by the Authlete console or provisioning APIs.

Path Parameters

serviceId
string
required

A service ID.

Body

application/json
entityTypes
enum<string>[]

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+).

The entity type, as defined in OpenID Federation 1.0.

Available options:
OPENID_RELYING_PARTY,
OPENID_PROVIDER,
OAUTH_AUTHORIZATION_SERVER,
OAUTH_CLIENT,
OAUTH_RESOURCE,
FEDERATION_ENTITY,
OPENID_CREDENTIAL_ISSUER

Response

Federation configuration retrieved successfully

resultCode
string

The code which represents the result of the API call.

resultMessage
string

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

action
enum<string>

The next action that the authorization server implementation should take.

Available options:
OK,
NOT_FOUND,
INTERNAL_SERVER_ERROR
responseContent
string

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