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

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.PreviewCimdMetadataRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.clients().previewCimdMetadata(
            PreviewCimdMetadataRequestContent
                .builder()
                .externalClientId("external_client_id")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Clients\Requests\PreviewCimdMetadataRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->clients->previewCimdMetadata(
    new PreviewCimdMetadataRequestContent([
        'externalClientId' => 'external_client_id',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.clients.preview_cimd_metadata(
    external_client_id="external_client_id",
)

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

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

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

}

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

クライアント CIMD プレビューの投稿

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

POST

https://{tenantDomain}/api/v2

clients

cimd

preview

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

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.PreviewCimdMetadataRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.clients().previewCimdMetadata(
            PreviewCimdMetadataRequestContent
                .builder()
                .externalClientId("external_client_id")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Clients\Requests\PreviewCimdMetadataRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->clients->previewCimdMetadata(
    new PreviewCimdMetadataRequestContent([
        'externalClientId' => 'external_client_id',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.clients.preview_cimd_metadata(
    external_client_id="external_client_id",
)

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

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

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

}

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

承認

Authorization

string

header

必須

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

ボディ

external_client_id

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

必須

Client ID メタデータドキュメントの URL

Required string length: 1 - 120

レスポンス

メタデータの取得と検証に成功したか、errors array を含む取得エラーが返されました。

client_id

string

この external_client_id で登録された既存のクライアントがある場合は、その client_id。

errors

string[]

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

mapped_fields

object

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

Show child attributes

validation

object

Client ID メタデータドキュメントのバリデーション結果

Show child attributes