Skip to main content

Создание нового пользователя

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

POST /tenants/{tenant_name}/users

Описание​

Создать нового пользователя с заданными параметрами.

Параметры​

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

НазваниеОбязательныйТип данныхОписание
usernameдаstringПри создании единичного пользователя обязательно укажите имя пользователя, пароль и адрес электронной почты для восстановления (в формате username@domain), в противном случае будет возвращен статус 400
passwordдаstringПароль нового пользователя
recovery_emailдаstringАдрес электронной почты для восстановления пароля
user_idнетstringИдентификационный номер пользователя,параметр используется LDAP-плагином (не вводить вручную)
roleнетstringРоль пользователя из перечня доступных ролей в текущем тенанте
emailдаstringАдрес электронной почты пользователя
quotaнетstringМаксимальный объем хранилища для пользователя, по умолчанию назначается в соответствии с настройками текущего тенанта
personalдаstringЛичные данные пользователя
tenant_nameдаstringИмя тенанта

Запрос​

curl -X 'POST' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/users?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> — имя тенанта;

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

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

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

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

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

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

Ответ​

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

  • 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"
}
  • 400 — Bad username, password or other parameter, check error message — Имя пользователя, пароль или другой параметр не соответствует требованиям, проверьте сообщение об ошибке. Пример вывода:
{
"message": "string"
}
  • 404 — Tenant not found — Тенант не найден. Пример вывода:
{
"message": "string"
}