アカウントを管理する

Cloudflare を使う顧客またはチームは、それぞれ独自のアカウントを持つ必要があります。これにより、リソースのセキュリティとアクセスを適切に保てます。各アカウントは、ゾーンとその他のリソースのコンテナーとして機能します。必要に応じて、1 つの顧客またはチームに対して複数のアカウントを用意することもできます。

Tenant API でアカウントを作成すると、そのアカウントは作成から継続管理、最終的な削除まで、Cloudflare ユーザーが所有します。

アカウントを作成する

Tenant API でアカウントを作成すると、そのアカウントは作成から継続管理、最終的な削除まで、Cloudflare ユーザーが所有します。

ダッシュボードでテナント配下にアカウントを作成する手順は次のとおりです。

Cloudflare ダッシュボード ↗ にログインします。
Tenants > Managed Accounts を開きます。
Create Account を選びます。
Account Name、Account Description、Tenant Unit を入力します。
適切なアカウントのサブスクリプションを選びます。
Add Account を選びます。

API でアカウントを作成するには、/accounts エンドポイントに POST リクエストを送り、次の値を含めます。

name string
- Cloudflare ダッシュボードに表示されるアカウント名です。
type enum
- 有効な値は standard（デフォルト）と enterprise です。セルフサービスのお客様は standard を、Enterprise のお客様は enterprise を使います。
unit object
- テナントユニットに関する情報です。
- id string
  - （任意）このアカウントを作成するユニットの ID です。ユーザーが複数のテナントを管理している場合は指定が必要です。ユニット ID はテナント詳細の unit_tag です。

Know-Your-Customer（任意）

KYC パラメーターはすべてテキストフィールドで、120 文字制限があります。Tenant 側で必須になっていない限り、任意です。

business_name string
- （任意）このアカウントに紐づく事業者名です。
business_address string
- （任意）このアカウントに紐づく事業者の住所です。
business_email string
- （任意）このアカウントに紐づく事業者のメールアドレスです。
business_phone string
- （任意）このアカウントに紐づく事業者の電話番号です。
external_metadata string
- （任意）このアカウントの外部メタデータです。

リクエストbash

curl "https://api.cloudflare.com/client/v4/accounts" \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "name": "<ACCOUNT_NAME>",
  "type": "standard"
}'

成功すると、HTTP ステータス 200 と次のレスポンス本文が返ります。

レスポンスjson

{
  "result": {
    "id": "2bab6ace8c72ed3f09b9eca6db1396bb",
    "name": "<ACCOUNT_NAME>",
    "type": "standard",
    "settings": {
      "enforce_twofactor": false
    }
  },
  "success": true,
  "errors": [],
  "messages": []
}

ユニット ID を含むリクエスト:

リクエストbash

curl "https://api.cloudflare.com/client/v4/accounts" \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "name": "<ACCOUNT_NAME>",
  "type": "standard",
  "unit": {
    "id": "1a2b3c4d5e6f7g8h"
  }
}'

ユニット ID と KYC を含むリクエスト:

リクエストbash

curl "https://api.cloudflare.com/client/v4/accounts" \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "name": "<ACCOUNT_NAME>",
  "type": "standard",
  "business_name": "Cloudflare",
  "business_email": "[email protected]",
  "business_address": "San Francisco",
  "business_phone": "1234567890",
  "external_metadata": "{'\''testKey'\'': '\''testValue'\''}",
  "unit": {
    "id": "1a2b3c4d5e6f7g8h"
  }
}'

アカウントを表示する

Tenant API でアカウントを作成すると、そのアカウントは作成から継続管理、最終的な削除まで、Cloudflare ユーザーが所有します。

ダッシュボードで、テナントが所有するアカウントを表示するには、次の手順を行います。

Cloudflare ダッシュボード ↗ にログインします。
Tenants > Managed Accounts を開きます。

API でテナントが所有するアカウントを取得するには、/accounts エンドポイントへ GET リクエストを送ります。

作成したアカウントの一覧に加え、ユーザーがすでにアクセスできるアカウントも返ります。

Requestbash

curl https://api.cloudflare.com/client/v4/accounts \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>"

Responsejson

{
	"result": [
		{
			"id": "a34bd6cc645a31486aa2ef71f1b9afb6",
			"name": "My Personal Account",
			"settings": {
				"enforce_twofactor": false
			}
		},
		{
			"id": "1b16db169c9cb7853009857198fae1b9",
			"name": "Created Account",
			"settings": {
				"enforce_twofactor": false
			}
		}
	],
	"result_info": {
		"page": 1,
		"per_page": 20,
		"total_pages": 1,
		"count": 2,
		"total_count": 2
	},
	"success": true,
	"errors": [],
	"messages": []
}

アカウントを更新する

アカウントを更新するには、/accounts/{account_id} エンドポイントへ PUT リクエストを送ります。

アカウントを削除する

作成したアカウントを削除するには、/accounts/{account_id} エンドポイントへ DELETE リクエストを送ります。

アカウントの削除は永続的で、そのアカウント下のゾーンやその他のリソースも削除されます。

一部のリソースは手動削除が必要です

次のリソースは、アカウントを削除しても 自動では削除されません。事前に手動で削除する必要があります。

Logpush ジョブ: アカウント削除後もログの配信が続きます。
Zero Trust Gateway の設定: アカウント削除後も DNS クエリの解決が続くことがあります。

完全に片付けるには、アカウント削除の前に、次のエンドポイントを順に呼び出してこれらのリソースを削除します。

Zero Trust Gateway の設定を削除します。

curl --request DELETE \
https://api.cloudflare.com/client/v4/accounts/{account_id}/gateway \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>"

Access organization を削除します。

curl --request DELETE \
https://api.cloudflare.com/client/v4/accounts/{account_id}/access/organizations \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>"

そのあと、アカウントを削除します（下記を参照）。

Requestbash

curl --request DELETE \
https://api.cloudflare.com/client/v4/accounts/{account_id} \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>"

成功したリクエストは、操作の確認として id を返します。

Responsejson

{
	"result": {
		"id": "1b16db169c9cb7853009857198fae1b9"
	},
	"success": true,
	"errors": [],
	"messages": []
}