TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.clients.previewCimdMetadata({
        external_client_id: "external_client_id",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.clients.previewCimdMetadata({
        external_client_id: "external_client_id",
    });
}
main();

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.PreviewCimdMetadataRequestContent{
        ExternalClientID: "external_client_id",
    }
    mgmt.Clients.PreviewCimdMetadata(
        context.TODO(),
        request,
    )
}

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

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

Client IDメタデータドキュメントをプレビューして検証

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

POST

https://{tenantDomain}/api/v2

clients

cimd

preview

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.clients.previewCimdMetadata({
        external_client_id: "external_client_id",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.clients.previewCimdMetadata({
        external_client_id: "external_client_id",
    });
}
main();

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.PreviewCimdMetadataRequestContent{
        ExternalClientID: "external_client_id",
    }
    mgmt.Clients.PreviewCimdMetadata(
        context.TODO(),
        request,
    )
}

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

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

承認

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。

external_metadata_created_by

enum<string>

クライアントの作成者を示します。値がadminの場合、クライアントがManagement API経由で登録されたことを示します。値がclientの場合、クライアントが動的に登録されたことを示します。

利用可能なオプション:

admin,

client

errors

string[]

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

validation

object

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

Show child attributes

mapped_fields

object

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

Show child attributes