Register or update a CIMD client via metadata URI

Idempotent registration for Client ID Metadata Document (CIMD) clients. Uses external_client_id as the unique identifier for upsert operations.

Create: Returns 201 when a new client is created (requires create:clients scope). Update: Returns 200 when an existing client is updated (requires update:clients scope).

This endpoint automatically:

• Fetches and validates the metadata document
• Maps CIMD fields to Auth0 client configuration
• Creates/rotates credentials from the JWKS
• Enforces CIMD security policies (HTTPS-only, no shared secrets)

POST https://{tenantDomain}/api/v2/clients/cimd/register

Register or update a CIMD client via metadata URI

cURL

curl --request POST \
  --url https://{tenantDomain}/api/v2/clients/cimd/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_client_id": "<string>"
}
'

200

{
  "client_id": "<string>",
  "mapped_fields": {
    "external_client_id": "<string>",
    "name": "<string>",
    "app_type": "<string>",
    "callbacks": [
      "<string>"
    ],
    "logo_uri": "<string>",
    "description": "<string>",
    "grant_types": [
      "<string>"
    ],
    "token_endpoint_auth_method": "<string>",
    "jwks_uri": "<string>",
    "client_authentication_methods": {
      "private_key_jwt": {
        "credentials": [
          {
            "credential_type": "<string>",
            "kid": "<string>",
            "alg": "<string>"
          }
        ]
      }
    }
  },
  "validation": {
    "valid": true,
    "violations": [
      "<string>"
    ],
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/jsonapplication/x-www-form-urlencoded

external_client_id · string<absolute-https-uri-or-empty> · required

URL to the Client ID Metadata Document. Acts as the unique identifier for upsert operations.

Required string length: 1 - 120

Response

200

application/json

CIMD client successfully updated (idempotent).

Response after successfully registering or updating a CIMD client

client_id · string · required

The Auth0 client_id of the created or updated client

mapped_fields · object · required

Auth0 client fields mapped from the Client ID Metadata Document

Show child attributes

validation · object · required

Validation result for the Client ID Metadata Document

Show child attributes