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}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    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>",
        ),
    )
    request := &management.UpdateCustomDomainRequestContent{}
    client.CustomDomains.Update(
        context.TODO(),
        "id",
        request,
    )
}

200

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

custom_client_ip_header · enum<string> | null · デフォルト: true-client-ip

クライアントの 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

レスポンス

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

verification · object · 必須

ドメインの検証設定。

Show child attributes

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。

relying_party_identifier · string<hostname>

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

tls_policy · string · デフォルト: recommended

TLS バージョンのポリシー