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.UpdateAsync(
            id: "id",
            request: new UpdateCustomDomainRequestContent()
        );
    }

}

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.UpdateCustomDomainRequestContent{}
    mgmt.CustomDomains.Update(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

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

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

        client.customDomains().update(
            "id",
            UpdateCustomDomainRequestContent
                .builder()
                .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\UpdateCustomDomainRequestContent;

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

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/custom-domains/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "custom_client_ip_header": "x-forwarded-for",
  "domain_metadata": {},
  "relying_party_identifier": "<string>",
  "tls_policy": "recommended"
}
'

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

ID でカスタムドメインを更新

カスタムドメインを更新します。

更新可能な属性は次のとおりです。

custom_client_ip_header
tls_policy

カスタムドメインの CUSTOM_CLIENT_IP_HEADER を更新する

ドメインの custom_client_ip_header を更新するには、送信するリクエスト本文を次のようにします。

{ "custom_client_ip_header": "cf-connecting-ip" }

カスタムドメインの TLS_POLICY を更新する

ドメインの tls_policy を更新するには、送信するリクエスト本文を次のようにします。

{ "tls_policy": "recommended" }

TLS ポリシー:

recommended - 現在一般的な用途では、TLS 1.2 のみが含まれます

注意事項:

各 TLS ポリシーで使用できる TLS の暗号スイートとプロトコルは業界の推奨事項に従っており、随時更新される場合があります。
compatible TLS ポリシーは現在サポートされていません。

PATCH

https://{tenantDomain}/api/v2

custom-domains

{id}

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.UpdateAsync(
            id: "id",
            request: new UpdateCustomDomainRequestContent()
        );
    }

}

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.UpdateCustomDomainRequestContent{}
    mgmt.CustomDomains.Update(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

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

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

        client.customDomains().update(
            "id",
            UpdateCustomDomainRequestContent
                .builder()
                .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\UpdateCustomDomainRequestContent;

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

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/custom-domains/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "custom_client_ip_header": "x-forwarded-for",
  "domain_metadata": {},
  "relying_party_identifier": "<string>",
  "tls_policy": "recommended"
}
'

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

承認

Authorization

string

header

必須

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

パスパラメータ

string

必須

更新するカスタムドメインの ID

ボディ

custom_client_ip_header

enum<string> | null

デフォルト:x-forwarded-for

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

利用可能なオプション:

true-client-ip,

cf-connecting-ip,

x-forwarded-for,

x-azure-clientip,

domain_metadata

object

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

Show child attributes

relying_party_identifier

string<hostname> | null

このカスタムドメインでパスキーに使用する Relying Party ID（rpId）。rpId を削除して完全なドメインの使用に戻すには、null に設定します。

Maximum string length: 255

tls_policy

enum<string>

デフォルト:recommended

recommended には TLS 1.2 が含まれます

利用可能なオプション:

recommended

レスポンス

カスタムドメインを更新しました。

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

verification

object

必須

ドメイン検証の設定。

Show child attributes

certificate

object

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

Show child attributes

custom_client_ip_header

string | null

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

domain_metadata

object

Show child attributes

is_default

boolean

デフォルト:false

これがデフォルトのカスタムドメインの場合は true、そうでない場合は false。

relying_party_identifier

string<hostname>

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

tls_policy

string

デフォルト:recommended

TLS バージョンのポリシー