Удаление и блокировка пользователя
Метод и конечная точка
DELETE /tenants/{tenant_name}/users/{id}
Описание
Удалить или заблокировать пользователя.
Параметры
Параметры для метода указаны в таблице.
| Название | Обязательный | Тип данных | Описание |
|---|---|---|---|
| delete_mode | нет | string | Определяет параметры ограничений работы пользователя. Основные значения: - disable, заблокировать пользователя; - reassign, переназначить все документы пользователю с предоставленным user_id и свободным именем пользователя; - keep_files, сохранить файлы и освободить имя пользователя; - full_delete, удалить все файлы и освободить имя пользователя; - для всех остальных значений параметра — отключить пользователя |
| new_user_id | нет | string | Идентификационный номер нового администратора/владельца папки, указывается при значении параметра delete_mode == 'reassign' |
| tenant_name | да | string | Имя тенанта |
| id | да | string | Идентификационный номер папки |
Запрос
curl -X 'DELETE' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/users/<FOLDER_ID>?delete_mode=<DELETE_MODE>&\
new_user_id=<NEW_USER_ID>" \
-H 'accept: application/json'
где:
-
<TENANT_NAME>— имя тенанта; -
<FOLDER_ID>— идентификационный номер папки; -
<DELETE_MODE>— значение параметра, определяющего действия с пользователем; -
<NEW_USER_ID>— идентификационный номер нового администратора/владельца папки.
Ответ
Возможные варианты ответов:
- 200 — Success — Успешно. Пример вывода:
{
"message": "string"
}