Post Oauth 2 Create Client

Deprecated

Not the supported registration path. Dynamic client registration is gated (allowDynamicClientRegistration: false); unauthenticated calls are rejected. Register clients via POST /api/auth/admin/oauth-clients (admin session or Initial Access Token) — see the self-service registration guide.

Register an OAuth2 application

Authentication

AuthorizationBearer
Bearer token authentication

Request

This endpoint expects an object.
redirect_urislist of anyRequired
scopestring or nullOptional
client_namestring or nullOptional
client_uristring or nullOptional
logo_uristring or nullOptional
contactslist of any or nullOptional
tos_uristring or nullOptional
policy_uristring or nullOptional
software_idstring or nullOptional
software_versionstring or nullOptional
software_statementstring or nullOptional
post_logout_redirect_urislist of any or nullOptional
backchannel_logout_uristring or nullOptional
backchannel_logout_session_requiredboolean or nullOptional
token_endpoint_auth_methodstring or nullOptionalDefaults to client_secret_basic
jwksstring or nullOptional
jwks_uristring or nullOptional
grant_typeslist of any or nullOptionalDefaults to ["authorization_code"]
response_typeslist of any or nullOptionalDefaults to ["code"]
typestring or nullOptional

Response

OAuth2 application registered successfully
client_idstring
Unique identifier for the client
client_secretstring
Secret key for the client
client_secret_expires_atdouble
Time the client secret will expire. If 0, the client secret will never expire.
scopestring

Space-separated scopes allowed by the client

user_idstring
ID of the user who registered the client, null if registered anonymously
client_id_issued_atdouble
Creation timestamp of this client
client_namestring
Name of the OAuth2 application
client_uristring
URI of the OAuth2 application
logo_uristring
Icon URI for the application
contactslist of strings
List representing ways to contact people responsible for this client, typically email addresses
tos_uristring
Client's terms of service uri
policy_uristring
Client's policy uri
software_idstring
Unique identifier assigned by the developer to help in the dynamic registration process
software_versionstring

Version identifier for the software_id

software_statementstring
JWT containing metadata values about the client software as claims
redirect_urislist of strings
List of allowed redirect uris
token_endpoint_auth_methodenum
Response types the client may use
grant_typeslist of enums
Requested authentication method for the token endpoint
response_typeslist of enums
Requested authentication method for the token endpoint
publicboolean
Whether the client is public as determined by the type
typeenum
Type of the client
disabledboolean
Whether the client is disabled
metadatamap from strings to any or null
Additional metadata for the application

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error