v1

latestOpenAPI 3.0.1License2026-07-17467229.7 KB
Registration

Get client information for a previously registered client.

Get client information for a previously registered client.

get/restv1/register

Query parameters

client_idstring required

Client ID that identifies client.

Headers

Authorizationstring required

Authorization header carrying "registration_access_token" issued before as a Bearer token

Response

OK

redirect_urisstring[]

Redirection URI values used by the Client. One of these registered Redirection URI values must exactly match the redirect_uri parameter value used in each Authorization Request

claims_redirect_uristring[]

Array of The Claims Redirect URIs to which the client wishes the authorization server to direct the requesting party's user agent after completing its interaction.

response_typesstring[]

A list of the OAuth 2.0 response_type values that the Client is declaring that it will restrict itself to using. If omitted, the default is that the Client will use only the code Response Type. Allowed values are code, token, id_token.

grant_typesstring[]

A list of the OAuth 2.0 Grant Types that the Client is declaring that it will restrict itself to using.

contactsstring[]

e-mail addresses of people responsible for this Client.

authorization_details_typesstring[]

authorization details types (RFC9396). Fine-graned access.

client_namestring

Name of the Client to be presented to the user.

logo_uristring

URL that references a logo for the Client application

client_uristring

URL of the home page of the Client. The value of this field must point to a valid Web page.

policy_uristring

URL that the Relying Party Client provides to the End-User to read about the how the profile data will be used.

tos_uristring

URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms of service.

jwks_uristring

URL for the Client's JSON Web Key Set (JWK) document containing key(s) that are used for signing requests to the OP. The JWK Set may also contain the Client's encryption keys(s) that are used by the OP to encrypt the responses to the Client. When both signing and encryption keys are made available, a use (Key Use) parameter value is required for all keys in the document to indicate each key's intended usage .

jwksstring

Client's JSON Web Key Set (JWK) document, passed by value. The semantics of the jwks parameter are the same as the jwks_uri parameter, other than that the JWK Set is passed by value, rather than by reference. This parameter is intended only to be used by Clients that, for some reason, are unable to use the jwks_uri parameter, for instance, by native applications that might not have a location to host the contents of the JWK Set. If a Client can use jwks_uri, it must not use jwks. One significant downside of jwks is that it does not enable key rotation. The jwks_uri and jwks parameters must not be used together.

sector_identifier_uristring

URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP.

subject_typestring

Subject type requested for the Client ID. Valid types include pairwise and public.

rpt_as_jwtboolean

Specifies whether RPT should be return as signed JWT.

access_token_as_jwtboolean

Specifies whether access token as signed JWT.

access_token_signing_algstring

Specifies signing algorithm that has to be used during JWT signing. If it's not specified, then the default OP signing algorithm will be used .

id_token_signed_response_algstring

JWS alg algorithm (JWA) required for signing the ID Token issued to this Client.

id_token_encrypted_response_algstring

JWE alg algorithm (JWA) required for encrypting the ID Token issued to this Client.

id_token_encrypted_response_encstring

JWE enc algorithm (JWA) required for encrypting the ID Token issued to this Client.

userinfo_signed_response_algstring

JWS alg algorithm (JWA) required for signing UserInfo Responses.

userinfo_encrypted_response_algstring

JWE alg algorithm (JWA) required for encrypting UserInfo Responses.

userinfo_encrypted_response_encstring

JWE enc algorithm (JWA) required for encrypting UserInfo Responses.

introspection_signed_response_algstring

JWS alg algorithm (JWA) required for signing Introspection Responses.

introspection_encrypted_response_algstring

JWE alg algorithm (JWA) required for encrypting Introspection Responses.

introspection_encrypted_response_encstring

JWE enc algorithm (JWA) required for encrypting Introspection Responses.

logout_status_jwt_signed_response_algstring

JWS alg algorithm (JWA) required for signing Logout Status JWT.

tx_token_signed_response_algstring

JWS alg algorithm (JWA) required for signing Transaction Token Responses.

tx_token_encrypted_response_algstring

JWE alg algorithm (JWA) required for encrypting Transaction Token Responses.

tx_token_encrypted_response_encstring

JWE enc algorithm (JWA) required for encrypting Transaction Token Responses.

request_object_signing_algstring

JWS alg algorithm (JWA) that must be used for signing Request Objects sent to the OP.

request_object_encryption_algstring

JWE alg algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP.

request_object_encryption_encstring

JWE enc algorithm (JWA) the RP is declaring that it may use for encrypting Request Objects sent to the OP.

token_endpoint_auth_methodstring

Requested Client Authentication method for the Token Endpoint.

additional_token_endpoint_auth_methodstring[]

Array of additional Client Authentication methods for the Token Endpoint

token_endpoint_auth_signing_algstring

JWS alg algorithm (JWA) that must be used for signing the JWT used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods.

default_max_ageinteger

Specifies the Default Maximum Authentication Age.

require_auth_timeboolean

Boolean value specifying whether the auth_time Claim in the ID Token is required. It is required when the value is true.

default_acr_valuesstring[]

Array of default requested Authentication Context Class Reference values that the Authorization Server must use for processing requests from the Client.

minimum_acr_levelinteger

Integer value which sets minimum acr level.

minimum_acr_level_autoresolveboolean

boolean value, if false and minimum_acr_level is higher then current acr_values then reject request. If true - resolve acr according to either client's minimum_acr_priority_list or AS auth_level_mapping

minimum_acr_priority_liststring[]

enables client to specify the acr order of preference, rather then just the next lowest integer value

initiate_login_uristring

Specifies the URI using the https scheme that the authorization server can call to initiate a login at the client.

groupsstring[]

Array of client's groups.

post_logout_redirect_urisstring[]

Provide the URLs supplied by the RP to request that the user be redirected to this location after a logout has been performed.

frontchannel_logout_uristring

RP URL that will cause the RP to log itself out when rendered in an iframe by the OP.

frontchannel_logout_session_requiredboolean

Boolean value specifying whether the RP requires that a session ID query parameter be included to identify the RP session at the OP when the logout_uri is used. If omitted, the default value is false.

backchannel_logout_uristring

RP URL that will cause the RP to log itself out when sent a Logout Token by the OP.

backchannel_logout_session_requiredboolean

Boolean value specifying whether the RP requires that a session ID Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false.

request_urisstring[]

Provide a list of request_uri values that are pre-registered by the Client for use at the Authorization Server.

scopesstring

This param will be removed in a future version because the correct is 'scope' not 'scopes', see (rfc7591).

claimsstring

String containing a space-separated list of claims that can be requested individually.

id_token_token_binding_cnfstring

Specifies the JWT Confirmation Method member name (e.g. tbh) that the Relying Party expects when receiving Token Bound ID Tokens. The presence of this parameter indicates that the Relying Party supports Token Binding of ID Tokens. If omitted, the default is that the Relying Party does not support Token Binding of ID Tokens.

tls_client_auth_subject_dnstring

An string representation of the expected subject distinguished name of the certificate, which the OAuth client will use in mutual TLS authentication.

allow_spontaneous_scopesboolean

Specifies whether to allow spontaneous scopes for client. The default value is false.

spontaneous_scopesstring[]

List of spontaneous scopes

run_introspection_script_before_jwt_creationboolean

Boolean value with default value false. If true and access_token_as_jwt=true then run introspection script and transfer claims into JWT.

keep_client_authorization_after_expirationboolean

Boolean value indicating if the client authorization will not be removed afer expiration (expiration date is same as client's expiration that created it). The default value is false.

scopestring[]

Provide list of scope which are used during authentication to authorize access to resource.

authorized_originsstring[]

specifies authorized JavaScript origins.

access_token_lifetimeinteger

Specifies the Client-specific access token expiration.

id_token_lifetimeinteger

Specifies the Client-specific id_token expiration in seconds.

tx_token_lifetimeinteger

Specifies the Client-specific tx_token expiration in seconds.

par_lifetimeinteger

Specifies the Client-specific PAR expiration in seconds.

require_pushed_authorization_requestsboolean

Boolean parameter indicating whether the only means of initiating an authorization request the client is allowed to use is a pushed authorization request. If omitted, the default value is "false".

software_idstring

Specifies a unique identifier string (UUID) assigned by the client developer or software publisher used by registration endpoints to identify the client software to be dynamically registered.

software_versionstring

Specifies a version identifier string for the client software identified by 'software_id'. The value of the 'software_version' should change on any update to the client software identified by the same 'software_id'.

software_statementstring

specifies a software statement containing client metadata values about the client software as claims. This is a string value containing the entire signed JWT.

backchannel_token_delivery_modestring

specifies how backchannel token will be deliveried.

backchannel_client_notification_endpointstring

Client Initiated Backchannel Authentication (CIBA) enables a Client to initiate the authentication of an end-user by means of out-of-band mechanisms. Upon receipt of the notification, the Client makes a request to the token endpoint to obtain the tokens.

backchannel_authentication_request_signing_algstring

The JWS algorithm alg value that the Client will use for signing authentication request, as described in Section 7.1.1. of OAuth 2.0 [RFC6749]. When omitted, the Client will not send signed authentication requests.

backchannel_user_code_parameterboolean

Boolean value specifying whether the Client supports the user_code parameter. If omitted, the default value is false.

Example response

{
  "redirect_uris": [
    "https://client.example.org/cb"
  ],
  "jwks": "{\"key1\": \"value1\", \"key2\": \"value2\"}",
  "default_max_age": 1000000,
  "minimum_acr_level": 10,
  "post_logout_redirect_uris": [
    "https://client.example.org/logout/page1",
    "https://client.example.org/logout/page2",
    "https://client.example.org/logout/page3"
  ],
  "scope": [
    "openid"
  ],
  "access_token_lifetime": 100,
  "id_token_lifetime": 600,
  "tx_token_lifetime": 600,
  "par_lifetime": 600,
  "software_id": "4NRB1-0XZABZI9E6-5SM3R",
  "software_version": "2.1",
  "backchannel_token_delivery_mode": "push, poll, ping"
}