テナントのデフォルトのカスタムドメインを更新する

TypeScript

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.customDomains.setDefault({
        domain: "domain",
    });
}
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.SetDefaultCustomDomainRequestContent{
        Domain: "domain",
    }
    mgmt.CustomDomains.SetDefault(
        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.CustomDomains.SetDefaultAsync(
            new SetDefaultCustomDomainRequestContent {
                Domain = "domain"
            }
        );
    }

}

package com.example.usage;

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

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

        client.customDomains().setDefault(
            SetDefaultCustomDomainRequestContent
                .builder()
                .domain("domain")
                .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\SetDefaultCustomDomainRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->customDomains->setDefault(
    new SetDefaultCustomDomainRequestContent([
        'domain' => 'domain',
    ]),
);

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/custom-domains/default \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>"
}
'

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

PATCH

https://{tenantDomain}/api/v2

custom-domains

default

TypeScript

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.customDomains.setDefault({
        domain: "domain",
    });
}
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.SetDefaultCustomDomainRequestContent{
        Domain: "domain",
    }
    mgmt.CustomDomains.SetDefault(
        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.CustomDomains.SetDefaultAsync(
            new SetDefaultCustomDomainRequestContent {
                Domain = "domain"
            }
        );
    }

}

package com.example.usage;

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

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

        client.customDomains().setDefault(
            SetDefaultCustomDomainRequestContent
                .builder()
                .domain("domain")
                .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\SetDefaultCustomDomainRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->customDomains->setDefault(
    new SetDefaultCustomDomainRequestContent([
        'domain' => 'domain',
    ]),
);

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/custom-domains/default \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>"
}
'

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

承認

Authorization

string

header

必須

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

ボディ

domain

string

必須

デフォルトのカスタムドメインとして設定するドメイン。検証済みのカスタムドメインまたは正規ドメインである必要があります。

Required string length: 3 - 255

レスポンス

デフォルトのカスタムドメインを正常に設定しました。

Option 1
Option 2

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

is_default

boolean

デフォルト:false

これがデフォルトのカスタムドメインかどうか（true または false）。

origin_domain_name

string

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

中継アドレス。

verification

object

ドメイン検証の設定。

Show child attributes

custom_client_ip_header

string | null

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

tls_policy

string

デフォルト:recommended

TLSバージョンのポリシー

domain_metadata

object

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

Show child attributes

certificate

object

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

Show child attributes

relying_party_identifier

string<hostname>

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