検証を実行

カスタムドメインの検証プロセスを実行します。

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

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

Auth0 管理証明書を使用するカスタムドメインの検証については、詳細を参照してください。 自己管理証明書を使用するカスタムドメインの検証については、詳細を参照してください。

POST https://{tenantDomain}/api/v2/custom-domains/{id}/verify

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.CustomDomains.Verify(
        context.TODO(),
        "id",
    )
}

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request POST \
  --url https://{tenantDomain}/api/v2/custom-domains/{id}/verify \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/custom-domains/{id}/verify"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/custom-domains/{id}/verify",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/custom-domains/{id}/verify")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/custom-domains/{id}/verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

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

レスポンス

200

application/json

カスタムドメインが正常に検証されました。

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キーのヘッダー。

custom_client_ip_header · string | null

クライアントの IP アドレスを取得するための HTTP ヘッダー

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