HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Create a dynamic client.

post
https://{tenanturl}/oauth2/register

Use this API to create a dynamic client. If dynamic client registration is configured to require bearer token authentication, the token needs to have the manageAppAccessAdmin (Manage application lifecycle) entitlement.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Body Params

Dynamic client payload

string

Access Policy ID.

boolean

Set to true if all users are entitled to use this client.

api_entitlements
array of strings

List of API entitlements.

api_entitlements
string

JWE 'alg' algorithm required for encrypting authorization responses.

string

JWE 'enc' algorithm required for encrypting authorization responses.

string

JWS 'alg' required for signing authorization responses.

authorize_request_mapping
array of objects

Configuration to add request parameters for authorize endpoint

authorize_request_mapping
authorize_response_mapping
array of objects

Configuration to add response parameters for authorize endpoint

authorize_response_mapping
string

Client name.

string
enum

Request for user consent.

Allowed:
boolean

Enforce the usage of PKCE.

grant_types
array of strings

Array of grant types that the client may use. The allowed grant types are 'authorization_code', 'implicit', 'password', and 'refresh_token'.

grant_types
string

JWE alg algorithm required for encrypting the ID Token assigned to this client.

string

JWE enc algorithm required for encrypting the ID Token assigned to this client.

string

Token signing algorithm required for signing the ID token issued for this client.

identity_providers
array of strings

List of identity providers.

identity_providers
string

URI that uses the https scheme that a third party can use to initiate a login by the RP.

string

URL referencing the client's JSON Web Key Set document representing the client's public keys.

redirect_uris
array of strings
required

Array of redirection URIs for use in redirect-based flows.

redirect_uris*
boolean

Flag to indicate whether expiry claims should be set in the request object.

string

JWE 'alg' algorithm the RP is declaring that it can use for encrypting Request Objects sent to the OP.

string

JWE 'enc' algorithm the RP is declaring that it can use for encrypting Request Objects sent to the OP.

integer

The lifetime of the request object.

boolean

Flag to suggest whether all the request parameters should only be in the request object.

string

JWS 'alg' algorithm that MUST be used for signing Request Objects sent to the OP.

boolean

Flag to indicate whether pushed authorization request (PAR) is required.

request_uris
array of strings

Array of request_uri values that are pre-registered by the RP for use at the OP.

request_uris
response_types
array of strings

Array of the OAuth 2.0 response types that the client may use.

response_types
boolean

Flag to indicate whether API entitlements should be restricted.

string

A space-delimited string of allowed scopes.

string

A unique identifier string that identifies the client software to be digitally registered.

string

A signed JWT that asserts metadata values about the client software as a bundle.

string

The theme ID, if any.

string

The expected DNS name SAN entry in the certificate that the client will use in mutual TLS authentication.

string

The expected subject distinguished name of the certificate that the client will use in mutual TLS authentication.

string

The expected email address SAN entry in the certificate that the client will use in mutual TLS authentication.

string

The expected IP address SAN entry in the certificate that the client will use in mutual TLS authentication.

string

The expected URI SAN entry in the certificate that the client will use in mutual TLS authentication.

boolean

Indicates if certificate binding for access token is required.

string
enum

The client authentication method for the token endpoint.

Allowed:
string

JWS 'alg' algorithm that must be used for signing the JWT used to authenticate the client at the Token Endpoint for the 'private_key_jwt' authentication methods.

boolean

Flag to indicate whether the JTI for token endpoint is single-use only.

token_request_mapping
array of objects

Configuration to add request parameters for token endpoint

token_request_mapping
token_response_mapping
array of objects

Configuration to add response parameters for token endpoint

token_response_mapping
string

Userinfo response JWT encryption algorithm.

string

Userinfo response JWT encryption content algorithm.

string

Userinfo response JWT signing algorithm.

string

Client ID. Will be automatically generated if not provided.

string

Client secret. Will be automatically generated if not provided.

id_token_claims
array of strings

List of claims for id_token and user information.

id_token_claims
token_claims
array of strings

List of claims for introspect and JWT access token.

token_claims
Headers
string

Bearer access token

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated over 2 years ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json
*/*

Updated over 2 years ago