Sign in

v1

latestOpenAPI 3.1.02026-07-247328324.6 KB
API authentication

Create a register

post/oauth/register

Headers

IdempotencyKeystring

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Example:978771af-77de-4e24-ba39-f602502ceb78

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Request body

redirect_urisstring[] required
token_endpoint_auth_method'none' | 'client_secret_post' | 'client_secret_basic'
grant_typesstring[]
response_typesstring[]
client_namestring

Non-empty text string

client_uristring uri

HTTP(S) URL

logo_uristring uri

HTTP(S) URL

scopestring
contactsstring[]
tos_uristring uri

HTTP(S) URL

policy_uristring uri

HTTP(S) URL

jwks_uristring uri

HTTP(S) URL

jwksobject

Key-value metadata object

software_idstring

Non-empty text string

software_versionstring

Non-empty text string

software_statementstring

Non-empty text string

Example request

{
  "redirect_uris": [
    "https://www.acme.com"
  ],
  "client_uri": "https://www.acme.com",
  "logo_uri": "https://www.acme.com",
  "contacts": [
    "email@domain.com"
  ],
  "tos_uri": "https://www.acme.com",
  "policy_uri": "https://www.acme.com",
  "jwks_uri": "https://www.acme.com",
  "jwks": {
    "key": "value"
  }
}

Response

Successful operation

redirect_urisstring[] required
token_endpoint_auth_method'none' | 'client_secret_post' | 'client_secret_basic'
grant_typesstring[]
response_typesstring[]
client_namestring

Non-empty text string

client_uristring uri

HTTP(S) URL

logo_uristring uri

HTTP(S) URL

scopestring
contactsstring[]
tos_uristring uri

HTTP(S) URL

policy_uristring uri

HTTP(S) URL

jwks_uristring uri

HTTP(S) URL

jwksobject

Key-value metadata object

software_idstring

Non-empty text string

software_versionstring

Non-empty text string

software_statementstring

Non-empty text string

client_idstring required

Non-empty text string

client_secretstring

Non-empty text string

client_id_issued_atinteger

Non-negative integer (0 to 2147483647)

client_secret_expires_atinteger

Non-negative integer (0 to 2147483647)

registration_client_uristring uri

HTTP(S) URL

registration_access_tokenstring

Non-empty text string

Example response

{
  "redirect_uris": [
    "https://www.acme.com"
  ],
  "client_uri": "https://www.acme.com",
  "logo_uri": "https://www.acme.com",
  "contacts": [
    "email@domain.com"
  ],
  "tos_uri": "https://www.acme.com",
  "policy_uri": "https://www.acme.com",
  "jwks_uri": "https://www.acme.com",
  "jwks": {
    "key": "value"
  },
  "client_id_issued_at": 42,
  "client_secret_expires_at": 42,
  "registration_client_uri": "https://www.acme.com"
}