カスタムドメインの取得

カスタムドメインの詳細を取得します。

GET https://{tenantDomain}/api/v2/custom-domains

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.List(
        context.TODO(),
    )
}

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

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

import requests

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

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

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/custom-domains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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.get("https://{tenantDomain}/api/v2/custom-domains")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.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>"
    },
    "custom_client_ip_header": "<string>",
    "domain_metadata": {},
    "is_default": false,
    "origin_domain_name": "mycompany_cd_0000000000000001.edge.tenants.auth0.com",
    "relying_party_identifier": "<string>",
    "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.

クエリパラメータ

take · integer

1 ページあたりの結果数。デフォルトは 50 です。

必須範囲: 1 <= x <= 100

from · string

取得を開始する開始位置の省略可能な Id。

Maximum string length: 1000

q · string

Lucene の query string 構文によるクエリ。

Maximum string length: 1000

fields · string

結果に含める、または除外するフィールドのカンマ区切りリストです（include_fields に指定した値に基づきます）。すべてのフィールドを取得するには空のままにします。

Maximum string length: 100

include_fields · boolean

指定したフィールドを含めるか（true）、除外するか（false）を示します。

sort · string

並べ替えに使用するフィールド。現時点でサポートされているのは domain:1 のみです（ドメインの昇順）。

Maximum string length: 15

レスポンス

200

application/json

カスタムドメインを正常に取得しました。

object[]

object

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

custom_client_ip_header · string | null

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

domain_metadata · object

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

Show child attributes

is_default · boolean · デフォルト: false

これがデフォルトのカスタムドメインであるかどうか（true）を示します。false の場合はデフォルトではありません。

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

中間アドレス。

relying_party_identifier · string<hostname>

このカスタムドメインでパスキーに使用する Relying Party ID（rpId）。指定されていない場合は、完全なドメインが使用されます。

tls_policy · string · デフォルト: recommended

TLS バージョン ポリシー

verification · object

ドメインの検証設定。

Show child attributes