Register an OAuth/OIDC client.

POST

/register

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "redirect_uris": [ "https://app.example.com/callback" ], "client_name": "Example App", "grant_types": [ "authorization_code", "refresh_token" ], "response_types": [ "code" ], "scope": "openid profile email", "require_pkce": true }'

Authorizations

• initialAccessToken

Request Body ^required

Media type application/json

object

redirect_uris

required

Array<string>

>= 1 items

client_name

string

grant_types

Array<string>

response_types

Array<string>

scope

string

token_endpoint_auth_method

string

require_pkce

boolean

jwks

object

key

additional properties

jwks_uri

string format: uri

sector_identifier_uri

string format: uri

logo_uri

string format: uri

policy_uri

string format: uri

tos_uri

string format: uri

logout_webhook_uri

string format: uri

key

additional properties

Example

{
  "redirect_uris": [
    "https://app.example.com/callback"
  ],
  "client_name": "Example App",
  "grant_types": [
    "authorization_code",
    "refresh_token"
  ],
  "response_types": [
    "code"
  ],
  "scope": "openid profile email",
  "require_pkce": true
}

Responses

201

Successful JSON response.

Media type application/json

object

client_id

required

string

client_secret

string

client_id_issued_at

required

integer

client_secret_expires_at

integer

registration_access_token

string

registration_client_uri

string format: uri

redirect_uris

required

Array<string>

require_pkce

required

boolean

key

additional properties

Example

{
  "client_id": "client_123",
  "client_secret": "secret_123",
  "client_id_issued_at": 1770000000,
  "client_secret_expires_at": 0,
  "registration_access_token": "reg_access_123",
  "registration_client_uri": "https://auth.example.com/clients/client_123",
  "redirect_uris": [
    "https://app.example.com/callback"
  ],
  "require_pkce": true
}

400

OAuth error response.

Media type application/json

object

error

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "error_description": "example"
}

401

OAuth error response.

Media type application/json

object

error

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "error_description": "example"
}