Изменение информации о пользователе

Метод и конечная точка

PUT /tenants/{tenant_name}/users/{id}

Описание

Отправляет обновление значений параметров пользователя.

Параметры

Параметры для метода указаны в таблице.

Название	Обязательный	Тип данных	Описание
enabled	нет	string	Если этот параметр указан, то пользователь будет разблокирован (сможет войти в систему), если он был заблокирован ранее
reset_password	нет	string	Параметр может принимать 3 значения: with_email (пользователю будет отправлено электронное письмо с просьбой восстановить пароль), hard (необходимо ввести новое значение пароля, или new_password), simply (срок действия пароля пользователя истечет и администратор сможет изменить пароль)
role	нет	string	Роль пользователя из перечня доступных ролей в текущем тенанте
quota	нет	string	Максимальный объем хранилища для пользователя. По умолчанию назначается в соответствии с настройками текущего тенанта
recovery_email	нет	string	Адрес электронной почты для восстановления пароля
except_ctype_prohibition	нет	string	Исключения для запрета загрузки медиатипов
personal	нет	string	Личные данные пользователя, такие как Имя, Фамилия и др.
tenant_name	да	string	Имя тенанта
id	да	string	Идентификационный номер пользователя, параметр используется LDAP-плагином. Не вводить вручную

Запрос

curl -X 'PUT' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/users/<ID>?username=<USER_NAME>&password=<PASSWORD>&\
recovery_email=<RECOVERY_EMAIL>&email=<USER_EMAIL>&quota=<QUOTA>&role=<ROLE>" \
--data-urlencode "personal={\
"first_name":"Фамилия",\
"last_name":"Имя",\
"middle_name":"Отчество"}\
-H 'accept: application/json'

где:

• <TENANT_NAME> — имя тенанта;

• <ID> —идентификационный номер пользователя;

• <USER_NAME> — имя пользователя (в формате username@domain);

• <PASSWORD> — пароль пользователя;

• <RECOVERY_EMAIL> — адрес электронной почты для воссановления пароля;

• <USER_EMAIL> — адрес электронной почты пользователя;

• <QUOTA> — максимальный объем хранилища для пользователя. По умолчанию назначается в соответствии с настройками текущего тенанта;

• <ROLE> — роль пользователя из перечня доступных ролей в текущем тенанте;

• <PERSONAL> — личные данные пользователя, такие как Имя, Фамилия и др.

Ответ

Возможные варианты ответов:

• 200 — Success — Успешно. Пример вывода:

{
"ctime": "string",
"domain": "string",
"enabled": true,
"except_ctype_prohibition": true,
"first_name": "string",
"id": "string",
"is_deleted": true,
"lang": "string",
"last_name": "string",
"middle_name": "string",
"password": "string",
"position": "string",
"quota": 0,
"recovery_email": "string",
"roles": [
{
"clientRole": true,
"composite": true,
"containerId": "string",
"description": "string",
"id": "string",
"name": "string"
}
],
"username": "string"
}

• 404 — Tenant not found — Тенант не найден. Пример вывода:

{
"message": "string"
}