クライアント Cimd プレビューの作成

クライアントを作成せずに Client ID Metadata Document を取得して検証します。 生のメタデータと、それが Auth0 のクライアントフィールドにどのようにマッピングされるかを返します。 このエンドポイントは、CIMD クライアントを作成する前にメタデータ URI をテストする際に役立ちます。

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

クライアントIDメタデータドキュメントをプレビューして検証

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

external_client_id · string<absolute-https-uri-or-empty> · 必須

クライアントIDメタデータドキュメントのURL

Required string length: 1 - 120

レスポンス

200

application/json

メタデータの取得と検証に成功しました。取得エラーが発生した場合は、errors 配列とともに返されます。

client_id · string

存在する場合、この external_client_id に登録されている既存のクライアントの client_id。

errors · string[]

取得エラーの配列（メタデータドキュメントを取得できなかった場合に設定されます）。存在する場合、検証は省略されます。

mapped_fields · object

クライアントIDメタデータドキュメントからマッピングされた Auth0 クライアントのフィールド

Show child attributes

validation · object

クライアントIDメタデータドキュメントの検証結果

Show child attributes