組織のドメインを作成

この組織に新しいドメインを作成します。

POST /domains

ドメインを作成する

cURL

curl --request POST \
  --url https://{tenantDomain}/my-org/v1/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "acme.com"
}
'

201

createOrgDomainResponseExample

{
  "domain": "acme.com",
  "id": "ord_aW1UHetvkBWSWdCCe8DWq7",
  "org_id": "org_zW1UHutvkVWSWdCC",
  "status": "pending",
  "verification_host": "_ss-verification.org_zW1UHutvkVWSWdCC.acme.com",
  "verification_txt": "dove_text=asdfpiujnlewp-23849jdkfjzxcfpiawer"
}

承認

OAuth2ClientCredentialsOAuth2AuthCode

Authorization · string · header · 必須

The access token received from the authorization server in the OAuth 2.0 flow.

ボディ

application/json

domain · string · 必須

ドメイン名。

Pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$

レスポンス

201

application/json

組織のドメインが正常に作成されました。

domain · string · 必須

ドメイン名。

Pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$

id · string · 必須 · read-only

組織ドメインの識別子。

Pattern: ^ord_[A-Za-z0-9]{22}$

org_id · string · 必須 · read-only

組織の識別子。

Pattern: ^org_[A-Za-z0-9]{16}$

status · enum<string> · 必須

組織ドメインのステータス。

利用可能なオプション: failed, pending, verified

verification_host · string · 必須

TXT レコードを追加する完全なドメインを保存します。

verification_txt · string · 必須

ドメインの検証に使用する値。