POST de Clients Cimd Preview

Obtiene y valida un documento de metadatos de ID de cliente sin crear un cliente. Devuelve los metadatos sin procesar y cómo se asignarían a los campos de cliente de Auth0. Este endpoint es útil para probar URI de metadatos antes de crear clientes CIMD.

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

Previsualizar y validar el documento de metadatos del ID de cliente

cURL

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

200

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

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Cuerpo

application/jsonapplication/x-www-form-urlencoded

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

URL del documento de metadatos del ID de cliente

Required string length: 1 - 120

Respuesta

200

application/json

Los metadatos se obtuvieron y validaron correctamente, o se devolvió un error de recuperación con un array de errores.

client_id · string

El client_id de un cliente existente registrado con este external_client_id, si existe.

errors · string[]

Matriz de errores de recuperación (se completa cuando no se pudo obtener el documento de metadatos). Cuando está presente, se omite la validación.

mapped_fields · object

Campos del cliente de Auth0 asignados desde el documento de metadatos de ID de cliente

Show child attributes

validation · object

Resultado de la validación del documento de metadatos de ID de cliente

Show child attributes