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

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Clients.RegisterCimdClientAsync(
            new RegisterCimdClientRequestContent {
                ExternalClientId = "external_client_id"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.clients.requests.RegisterCimdClientRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .token("<token>")
            .build();

        client.clients().registerCimdClient(
            RegisterCimdClientRequestContent
                .builder()
                .externalClientId("external_client_id")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Clients\Requests\RegisterCimdClientRequestContent;

$client = new Management(
    token: '<token>',
);
$client->clients->registerCimdClient(
    new RegisterCimdClientRequestContent([
        'externalClientId' => 'external_client_id',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.clients.register_cimd_client(
    external_client_id="external_client_id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>")

client.clients.register_cimd_client(external_client_id: "external_client_id")

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>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({external_client_id: '<string>'})
};

fetch('https://{tenantDomain}/api/v2/clients/cimd/register', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/clients/cimd/register"

	payload := strings.NewReader("{\n  \"external_client_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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>"
    ]
  }
}

{
  "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