カスタムドメインを取得

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.ListAsync(
            new ListCustomDomainsRequestParameters {
                Q = "q",
                Fields = "fields",
                IncludeFields = true,
                Sort = "sort"
            }
        );
    }

}

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

package com.example.usage;

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

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

        client.customDomains().list(
            ListCustomDomainsRequestParameters
                .builder()
                .q("q")
                .fields("fields")
                .includeFields(true)
                .sort("sort")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\CustomDomains\Requests\ListCustomDomainsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->customDomains->list(
    new ListCustomDomainsRequestParameters([
        'q' => 'q',
        'fields' => 'fields',
        'includeFields' => true,
        'sort' => 'sort',
    ]),
);

from auth0.management import ManagementClient

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

client.custom_domains.list(
    q="q",
    fields="fields",
    include_fields=True,
    sort="sort",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.custom_domains.list(
  q: "q",
  fields: "fields",
  include_fields: true,
  sort: "sort"
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.customDomains.list();
}
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>"
    },
    "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"
        }
      ]
    }
  }
]

GET

https://{tenantDomain}/api/v2

custom-domains

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.ListAsync(
            new ListCustomDomainsRequestParameters {
                Q = "q",
                Fields = "fields",
                IncludeFields = true,
                Sort = "sort"
            }
        );
    }

}

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

package com.example.usage;

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

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

        client.customDomains().list(
            ListCustomDomainsRequestParameters
                .builder()
                .q("q")
                .fields("fields")
                .includeFields(true)
                .sort("sort")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\CustomDomains\Requests\ListCustomDomainsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->customDomains->list(
    new ListCustomDomainsRequestParameters([
        'q' => 'q',
        'fields' => 'fields',
        'includeFields' => true,
        'sort' => 'sort',
    ]),
);

from auth0.management import ManagementClient

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

client.custom_domains.list(
    q="q",
    fields="fields",
    include_fields=True,
    sort="sort",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.custom_domains.list(
  q: "q",
  fields: "fields",
  include_fields: true,
  sort: "sort"
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.customDomains.list();
}
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>"
    },
    "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"
        }
      ]
    }
  }
]

承認

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

string

Lucene クエリ文字列構文によるクエリ。

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

レスポンス

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

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 header

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