...
Заголовок | Описание |
---|---|
Authorization (обязательный) | Токен доступа. Вы можете получить токен с помощью запроса. |
Параметр | Описание |
email (необязательный) | Email пользователя, которого вы добавляете. |
login (обязательный) | Логин нового пользователя. |
password (необязательный) | Пароль пользователя, которого вы добавляете. |
departmentId (обязательный) | ID подразделения, в которое будет добавлен пользователь. |
sendLoginEmail (необязательный, по умолчанию: false) | Параметр отвечает за отправку сообщения с данными пользователю. |
invitationMessage (обязательный, если в параметре sendLoginEmail указано значение true) | Текст email-сообщения, которое отправляется добавленному пользователю. |
sendLoginSMS (необязательный, по умолчанию: false) | Параметр отвечает за отправку SMS с данными пользователю. |
invitationSMSMessage (обязательный, если в параметре sendLoginSMS указано значение true) | Текст SMS, которое отправляется добавленному пользователю. |
role (необязательный) | Если вы назначаете пользователю одну из стандартных ролей (кроме Владельца аккаунта и Автора), присвойте параметру role одно из следующих значений:
Если вы назначаете пользователю роль Автора или одну из ролей с индивидуальными настройками, присвойте параметру role значение custom. |
roleId (обязательный, если в параметре role указано значение custom) | Параметр roleId используется, если вы назначаете пользователю роль Автора или одну из ролей с индивидуальными настройками. В этом случае присвойте параметру roleId ID нужной роли. Узнайте больше об использовании параметра roleId в разделе Важно. |
manageableDepartmentIds (обязательный, если роль пользователя — Администратор аккаунта, Автор или роль с индивидуальными настройками) | Список ID подразделений, которыми будет управлять пользователь, если его роль — Администратор подразделения, Автор или роль с индивидуальными настройками. |
groups (необязательный) | Список ID групп, в которых будет состоять пользователь. |
roles (необязательный) | Массив данных, с помощью которого вы можете назначать пользователю одну или две роли. Присвойте параметру roleId внутри массива ID нужной роли. |
Параметры ответа
Параметр | Описание |
---|---|
user_id | ID добавленного пользователя. |
Информация | ||||||
---|---|---|---|---|---|---|
Якорь |
|
...
Код | Текст | Описание |
---|---|---|
200 | OK | Пользователь добавлен. Тело Тело ответа будет содержать ID добавленного пользователя. |
400 | Bad Request | Ошибка в запросе. |
401 | Unauthorized | Ошибка авторизации. |
403 | Permission Denied | У пользователя нет прав для добавления. Например, Администратор подразделения не может добавить пользователя в подразделение, которым не управляет. |
Пример запроса
Блок кода | ||
---|---|---|
| ||
POST /user https/1.1 Host: api-learn.ispringlearn.ru Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE Content-Type:application/xml <?xml version="1.0" encoding="UTF-8"?> <request> <departmentId>1b7270ce-5cf5-11e9-a78e-0a580af40692</departmentId> <password>password v2</password> <fields> <login>ekaterina.ivanova</login> <phone>+79101231232</phone> <email>eivanova@ispring.ru</email> <first_name>Екатерина</first_name> <last_name>Иванова</last_name> <job_title>Менеджер по продажам</job_title> </fields> <role>custom</role> <roleId>928af650-af7e-11e9-9fa2-0a73fd48768b</roleId> <manageableDepartmentIds> <id>b00ba37c-5b6f-11e9-bb45-0a580af40556</id> <id>aff46554-5b6f-11e9-80e4-0a580af40556</id> </manageableDepartmentIds> <groupIds> <id>270ebbfa-5f6f-11e9-878e-0a580af406fd</id> </groupIds> <roles> <role> <roleId>efb18a8e-7be7-11ea-a17c-9e2d25e528cc</roleId> <manageableDepartmentIds> <id>783eee2e-7b51-11ea-ae7d-9e2d25e528cc</id> </manageableDepartmentIds> </role> <role> <roleId>eaf02558-2ae1-11e9-8b17-0242ac13000a</roleId> </role> </roles> <sendLoginEmail>true</sendLoginEmail> <invitationMessage>Используйте следующие данные, чтобы войти в Академию iSpring: </invitationMessage> <sendLoginSMS>true</sendLoginSMS> <invitationSMSMessage>Используйте следующие данные, чтобы войти в Академию iSpring: </invitationSMSMessage> </request> |
...