Aperçu POST des applications Cimd

Prévisualiser et valider le document de métadonnées de l’ID client

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

import requests

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

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/preview', 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/preview",
  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/preview"

	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/preview")
  .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/preview")

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>",
  "errors": [
    "<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>"
    ]
  }
}

POST

https://{tenantDomain}/api/v2

clients

cimd

preview

Prévisualiser et valider le document de métadonnées de l’ID client

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

import requests

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

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/preview', 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/preview",
  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/preview"

	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/preview")
  .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/preview")

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>",
  "errors": [
    "<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

Required string length: 1 - 120

Réponse

Métadonnées récupérées et validées avec succès, ou erreur de récupération renvoyée avec un tableau d’erreurs.

client_id

string

Le client_id d’une application existante enregistrée avec cet external_client_id, s’il en existe une.

errors

string[]

Tableau des erreurs de récupération (rempli lorsque le document de métadonnées n’a pas pu être récupéré). Lorsqu’il est présent, la validation est ignorée.

mapped_fields

object

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

Show child attributes

validation

object

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

Show child attributes

Créer des clients

Enregistrement CIMD des applications