INTEGRITY Документация

Управление аккаунтами

У каждого клиента или команды, использующих Cloudflare, должен быть собственный аккаунт. Это обеспечивает надлежащую безопасность и корректный доступ к ресурсам. Каждый аккаунт представляет собой контейнер для зон и других ресурсов. В зависимости от ваших потребностей вы можете создать несколько аккаунтов даже для одного клиента или команды.

Когда вы создаете аккаунт с помощью Tenant API, ваш пользователь Cloudflare владеет этим аккаунтом на всех этапах: от создания и текущего управления до итогового удаления.

Создание учётной записи

У каждого клиента или команды, использующих Cloudflare, должен быть собственный аккаунт. Это обеспечивает надлежащую безопасность и корректный доступ к ресурсам. Каждый аккаунт представляет собой контейнер для зон и других ресурсов. В зависимости от ваших потребностей вы можете создать несколько аккаунтов даже для одного клиента или команды.

Когда вы создаете аккаунт с помощью Tenant API, ваш пользователь Cloudflare владеет этим аккаунтом на всех этапах: от создания и текущего управления до итогового удаления.

Чтобы создать аккаунт в рамках вашего Tenant с помощью панели управления:

  1. Войдите в Панель управления Cloudflare ↗.
  2. Перейдите в Tenant > Управляемые аккаунты.
  3. Выберите Create Account.
  4. Введите Имя аккаунта, Account Description, а также Tenant unit.
  5. Выберите подходящую подписку аккаунта.
  6. Выберите Add Account.

Чтобы создать аккаунт с помощью API, выполните POST запрос к /accounts конечная точка и укажите следующие значения:

  • name строка

    • Название аккаунта, которое отображается в панели управления Cloudflare.
  • type enum

    • Допустимыми значениями являются standard (по умолчанию) и enterprise. Для клиентов на самообслуживании используйте standard. Для клиентов уровня Enterprise используйте enterprise.
  • unit объект

    • Сведения о единице тенанта.

    • id строка

      • (необязательно) ID unit, в котором нужно создать этот аккаунт. Указывается, если пользователь управляет несколькими Tenant. ID unit это unit_tag из вашего сведения о Tenant.

Know-Your-Customer (опционально)

Все параметры KYC являются текстовыми полями, имеют ограничение в 120 символов и необязательны, если иное не требует Tenant.

  • business_name строка

    • (необязательно) Название организации, связанной с этим аккаунтом.
  • business_address строка

    • (необязательно) Адрес организации, связанной с этим аккаунтом.
  • business_email строка

    • (необязательно) Email организации, связанной с этим аккаунтом.
  • business_phone строка

    • (необязательно) Номер телефона организации, связанной с этим аккаунтом.
  • external_metadata строка

    • (необязательно) Внешние метаданные для этого аккаунта.
Запрос
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 и следующим телом ответа:

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

Запрос с ID unit:

Запрос
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 unit и KYC:

Запрос
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 владеет этим аккаунтом на всех этапах: от создания и текущего управления до итогового удаления.

Чтобы просмотреть аккаунты, принадлежащие вашему Tenant, с помощью панели управления:

  1. Войдите в Панель управления Cloudflare ↗.
  2. Перейдите в Tenant > Управляемые аккаунты.

Чтобы получить с помощью API аккаунты, принадлежащие вашему Tenant, отправьте 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": "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": []
}

Обновить аккаунт

Чтобы обновить аккаунт, отправьте 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": []
}