デフォルトを部分更新

テナントのデフォルトカスタムドメインを設定します。

PATCH https://{tenantDomain}/api/v2/custom-domains/default

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

cURL

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

import requests

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

payload = { "domain": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domain: '<string>'})
};

fetch('https://{tenantDomain}/api/v2/custom-domains/default', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/custom-domains/default",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"domain\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/custom-domains/default")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"<string>\"\n}"

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.

ボディ

application/jsonapplication/x-www-form-urlencoded

domain · string · 必須

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

Required string length: 3 - 255

レスポンス

200

application/json

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

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

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