Prévisualiser et valider le Client ID Metadata Document

Récupère et valide un Client ID Metadata Document sans créer de client. Retourne les métadonnées brutes et la façon dont elles seraient mappées aux champs client d’Auth0. Cet endpoint est utile pour tester les URI de métadonnées avant de créer des clients CIMD.

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

C#

C#

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Clients.PreviewCimdMetadataAsync(
            new PreviewCimdMetadataRequestContent {
                ExternalClientId = "external_client_id"
            }
        );
    }

}

200

{
  "client_id": "<string>",
  "external_metadata_created_by": "admin",
  "errors": [
    "<string>"
  ],
  "validation": {
    "valid": true,
    "violations": [
      "<string>"
    ],
    "warnings": [
      "<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>"
          }
        ]
      }
    }
  }
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Corps

application/jsonapplication/x-www-form-urlencoded

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

200

application/json

Métadonnées récupérées et validées avec succès, ou erreur de récupération renvoyée avec le array errors.

client_id · string

Le client_id d’un client existant enregistré avec cet external_client_id, s’il en existe un.

external_metadata_created_by · enum<string>

Indique qui a créé le client. La valeur admin indique que le client a été enregistré au moyen de la Management API. La valeur client indique que le client a été enregistré dynamiquement.

Options disponibles: admin, client

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 omise.

validation · object

Résultat de la validation du Client ID Metadata Document

Show child attributes

mapped_fields · object

Champs du client Auth0 mappés à partir du Client ID Metadata Document

Show child attributes