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.CustomDomains.VerifyAsync(
            "id"
        );
    }

}

package example

import (
    context "context"

    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
    }
    mgmt.CustomDomains.Verify(
        context.TODO(),
        "id",
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

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

        client.customDomains().verify("id");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->customDomains->verify(
    'id',
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.customDomains.verify("id");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.customDomains.verify("id");
}
main();

{
  "custom_domain_id": "cd_0000000000000001",
  "domain": "login.mycompany.com",
  "primary": false,
  "status": "ready",
  "type": "self_managed_certs",
  "certificate": {
    "error_msg": "<string>",
    "renews_before": "<string>"
  },
  "cname_api_key": "d4feca...",
  "custom_client_ip_header": "<string>",
  "domain_metadata": {},
  "origin_domain_name": "mycompany_cd_0000000000000001.edge.tenants.auth0.com",
  "tls_policy": "recommended",
  "verification": {
    "error_msg": "<string>",
    "last_verified_at": "<string>",
    "methods": [
      {
        "name": "txt",
        "record": "auth0-domain-verification=...",
        "domain": "_cf-custom-hostname.login.mycompany.com"
      }
    ]
  }
}

Verify を送信

カスタムドメインで検証処理を実行します。

注: 検証ステータスを確認するには、status フィールドを確認してください。検証が完了しても、カスタムドメインがリクエストの受け付けを開始するまでに最大 10 分かかる場合があります。

self_managed_certs の場合、カスタムドメインが初めて検証されると、レスポンスにはプロキシの設定に必要な cname_api_key も含まれます。このキーは秘密として厳重に管理する必要があり、プロキシからのリクエストを検証するために使用されます。

Auth0 Managed certificates を使用するカスタムドメインの検証については、詳細はこちらを参照してください。 Self Managed certificates を使用するカスタムドメインの検証については、詳細はこちらを参照してください。

POST

https://{tenantDomain}/api/v2

custom-domains

{id}

verify

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.CustomDomains.VerifyAsync(
            "id"
        );
    }

}

package example

import (
    context "context"

    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
    }
    mgmt.CustomDomains.Verify(
        context.TODO(),
        "id",
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

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

        client.customDomains().verify("id");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->customDomains->verify(
    'id',
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.customDomains.verify("id");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.customDomains.verify("id");
}
main();

{
  "custom_domain_id": "cd_0000000000000001",
  "domain": "login.mycompany.com",
  "primary": false,
  "status": "ready",
  "type": "self_managed_certs",
  "certificate": {
    "error_msg": "<string>",
    "renews_before": "<string>"
  },
  "cname_api_key": "d4feca...",
  "custom_client_ip_header": "<string>",
  "domain_metadata": {},
  "origin_domain_name": "mycompany_cd_0000000000000001.edge.tenants.auth0.com",
  "tls_policy": "recommended",
  "verification": {
    "error_msg": "<string>",
    "last_verified_at": "<string>",
    "methods": [
      {
        "name": "txt",
        "record": "auth0-domain-verification=...",
        "domain": "_cf-custom-hostname.login.mycompany.com"
      }
    ]
  }
}

承認

Authorization

string

header

必須

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

パスパラメータ

string

必須

検証するカスタムドメインの ID。

レスポンス

カスタムドメインの検証が正常に完了しました。

custom_domain_id

string

デフォルト:cd_0000000000000001

必須

カスタムドメインのID。

domain

string

デフォルト:login.mycompany.com

必須

ドメイン名。

primary

boolean

デフォルト:false

必須

これがプライマリドメイン（true）かどうか。そうでない場合は false。

status

enum<string>

デフォルト:ready

必須

カスタムドメインの設定ステータス。failed、pending_verification、または ready のいずれかになります。

利用可能なオプション:

pending_verification,

ready,

failed

type

enum<string>

デフォルト:self_managed_certs

必須

カスタムドメインのプロビジョニングタイプ。auth0_managed_certs または self_managed_certs のいずれかになります。

利用可能なオプション:

auth0_managed_certs,

self_managed_certs

certificate

object

証明書情報。このオブジェクトは、Auth0 管理の証明書を使用するカスタムドメインにのみ関連します。

Show child attributes

cname_api_key

string

デフォルト:d4feca...

CNAME API key header。

custom_client_ip_header

string | null

クライアントの IP アドレスを取得するための HTTP header

domain_metadata

object

カスタムドメインに関連付けられたドメインのメタデータ。文字列値（最大 255 文字）を持つオブジェクト形式です。ドメインのメタデータプロパティは最大 10 個まで指定できます。

Show child attributes

origin_domain_name

string

デフォルト:mycompany_cd_0000000000000001.edge.tenants.auth0.com

中継アドレス。

tls_policy

string

デフォルト:recommended

TLS バージョンのポリシー

verification

object

ドメイン検証の設定。

Show child attributes