Удаление домена из тенанта
Метод и конечная точка
DELETE /tenants/{tenant_name}/domains/{domain}
Описание
Удаляет домен из тенанта.
Параметры
Перечень параметров представлен в таблице.
| Название | Обязательный | Тип данных | Описание |
|---|---|---|---|
| domain | да | string | Имя удаляемого домена |
| tenant_name | да | string | Имя тенанта |
Запрос
curl -X 'DELETE' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/domains?domain=<DOMAIN_NAME>" \
-H 'accept: application/json'
где:
<TENANT_NAME>— имя тенанта;$LOGIN_TOKEN— токен авторизации полученный в разделе Настройка токена авторизации.
Ответ
Возможные варианты ответов:
- 200 — Success — Успешно. Пример вывода:
{
"domains":
[ "string"
]
}
- 400 — Cannot delete default domain or cannot delete domain because some users have emails with it — Невозможно удалить домен, так как у некоторых пользователей есть почтовый ящик с его именем. Пример вывода:
{
"message": "string"
}