Enregistrer ou mettre à jour un client CIMD au moyen de l’URI de métadonnées

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

import requests

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

payload = { "external_client_id": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/clients/cimd/register",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'external_client_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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))

}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/clients/cimd/register")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_client_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_client_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

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

Enregistrement CIMD des applications

Enregistrement idempotent pour les clients CIMD (Client ID Metadata Document). Utilise external_client_id comme identifiant unique pour les opérations d’upsert.

Création : Retourne 201 lorsqu’un nouveau client est créé (nécessite le scope create:clients). Mise à jour : Retourne 200 lorsqu’un client existant est mis à jour (nécessite le scope update:clients).

Ce point de terminaison :

Récupère et valide le document de métadonnées
Associe les champs CIMD à la configuration du client Auth0
Crée les identifiants à partir du JWKS ou en effectue la rotation
Applique les politiques de sécurité CIMD (HTTPS uniquement, aucun secret partagé)

POST

https://{tenantDomain}/api/v2

clients

cimd

Enregistrer ou mettre à jour un client CIMD au moyen de l’URI de métadonnées

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

import requests

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

payload = { "external_client_id": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/clients/cimd/register",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'external_client_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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))

}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/clients/cimd/register")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_client_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_client_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

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

Autorisations

Authorization

string

header

requis

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

Corps

external_client_id

string<absolute-https-uri-or-empty>

requis

URL du document de métadonnées de l’ID client. Sert d’identifiant unique pour les opérations d’upsert.

Required string length: 1 - 120

Réponse

Client CIMD mis à jour avec succès (idempotent).

Réponse après l’enregistrement ou la mise à jour réussie d’un client CIMD

client_id

string

requis

Le client_id Auth0 du client créé ou mis à jour

mapped_fields

object

requis

Champs du client Auth0 mis en correspondance à partir du document de métadonnées ID client

Show child attributes

validation

object

requis

Résultat de la validation du document de métadonnées ID client

Show child attributes

Aperçu POST des applications Cimd

Récupérer les identifiants