アカウントの管理

Each customer or team that uses Cloudflare should have their own account. This ensures proper security and access of resources. Each account acts as a container of zones and other resources. Depending on your needs, you may even provision multiple accounts for a single customer or team.

When you create an account with the Tenant API, your Cloudflare user owns that account from creation, ongoing management, and finally deletion.

アカウントの作成

Each customer or team that uses Cloudflare should have their own account. This ensures proper security and access of resources. Each account acts as a container of zones and other resources. Depending on your needs, you may even provision multiple accounts for a single customer or team.

When you create an account with the Tenant API, your Cloudflare user owns that account from creation, ongoing management, and finally deletion.

ダッシュボード

To create an account under your tenant using the dashboard:

1. Log into the Cloudflare dashboard ↗.
2. Go to Tenants > Managed Accounts.
3. Select Create Account.
4. Enter the Account Name, Account Description, and Tenant Unit.
5. Choose the appropriate account subscription.
6. Select Add Account.

API

To create an account using the API, make a POST request to the /accounts endpoint and include the following values:

• name string

  • The name of the account that is displayed in the Cloudflare dashboard.

• type enum

  • Valid values are standard (default) and enterprise. For self-serve customers, use standard. For enterprise customers, use enterprise.

• unit object

  • Information related to the tenant unit.

  • id string

    • (optional) ID of the unit to create this account on. Needs to be specified if user administers multiple tenants. Unit ID is the unit_tag from your tenant details.

Know-Your-Customer (optional)

All KYC parameters are text fields, have a 120 character limit, and are optional unless enforced by the Tenant.

• business_name string

  • (optional) The name of the business associated with this account.

• business_address string

  • (optional) The address of the business associated with this account.

• business_email string

  • (optional) The email of the business associated with this account.

• business_phone string

  • (optional) The phone number of the business associated with this account.

• external_metadata string

  • (optional) External metadata for this account.

Request

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

A successful request will return an HTTP status of 200 and the following response body:

Response

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

A request with a unit ID:

Request

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

A request with a unit ID and KYC:

Request

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@business.com",
  "business_address": "San Francisco",
  "business_phone": "1234567890",
  "external_metadata": "{'\''testKey'\'': '\''testValue'\''}",
  "unit": {
    "id": "1a2b3c4d5e6f7g8h"
  }
}'

アカウントの表示

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

ダッシュボード

ダッシュボードを使用して、テナントが所有するアカウントを表示するには：

1. Cloudflareダッシュボード ↗にログインします。
2. テナント > 管理アカウントに移動します。

API

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

作成したすべてのアカウントと、ユーザーがすでにアクセス権を持っているアカウントのリストが返されます。

リクエスト

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

レスポンス

{
  "result": [
    {
      "id": "a34bd6cc645a31486aa2ef71f1b9afb6",
      "name": "私の個人アカウント",
      "settings": {
        "enforce_twofactor": false
      }
    },
    {
      "id": "1b16db169c9cb7853009857198fae1b9",
      "name": "作成されたアカウント",
      "settings": {
        "enforce_twofactor": false
      }
    }
  ],
  "result_info": {
    "page": 1,
    "per_page": 20,
    "total_pages": 1,
    "count": 2,
    "total_count": 2
  },
  "success": true,
  "errors": [],
  "messages": []
}

アカウントの更新

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

アカウントの削除

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

アカウントの削除は永久的であり、そのアカウントに関連するゾーンやその他のリソースも削除されます。

リクエスト

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

成功したリクエストは、操作を確認するためのidを返します：

レスポンス

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