Включить страницу | ||||
---|---|---|---|---|
|
Метод: addUser
Оглавление minLevel 2
Права пользователя для выполнения запроса
...
Параметры запроса
Параметр | Тип | Описание | |||
---|---|---|---|---|---|
credentials token (обязательный) | credentials | string | Токен доступа. Вы можете получить токен с помощью запросаСмотрите описание объекта Credentials. | ||
email (необязательный) | string | Email пользователя, которого вы добавляете. | |||
login (обязательный) | string | Логин нового пользователя. | |||
password (необязательный) | string | Пароль пользователя, которого вы добавляете. | |||
departmentId (обязательный) | string | ID подразделения, в которое будет добавлен пользователь. | |||
sendLoginEmail (необязательный, по умолчанию: true false) | bool | Параметр отвечает за отправку сообщения с данными пользователю. | invitationMessage (необязательный) | string | |
invitationMessage (обязательный, если в параметре sendLoginEmail указано значение true) | string | Текст email-сообщения, которое отправляется добавленному пользователю | |||
sendLoginSMS (необязательный, по умолчанию: false) | bool | Параметр отвечает за отправку SMS с данными пользователю | |||
invitationSMSMessage (обязательный, если в параметре sendLoginSMS указано значение true) | string | Текст SMS, которое отправляется добавленному пользователю | Текст сообщения, который будет отображаться в письме.|||
role (необязательный) | string | Если вы назначаете пользователю одну из стандартных ролей (кроме Владельца аккаунта и Автора), присвойте параметру role одно из следующих значений:
Если вы назначаете пользователю роль Автора или одну из ролей с индивидуальными настройками, присвойте параметру role значение custom. | |||
roleId (обязательный, если в параметре role указано значение custom) | string | Параметр roleId используется, если вы назначаете пользователю роль Автора или одну из ролей с индивидуальными настройками. В этом случае присвойте параметру roleId ID нужной роли. Узнайте больше об использовании параметра roleId в разделе Важно. | |||
manageableDepartmentIds (обязательный, если роль пользователя — department_administrator, publisher или роль с индивидуальными настройками) | string[] | Список ID подразделений, которыми будет управлять пользователь, если его роль — Администратор подразделения, Автор или роль с индивидуальными настройками. | |||
groups (необязательный) | string[] | Список ID группID групп, в которых будет состоять пользователь. | |||
roles (необязательный) | string[] | Массив данных, с помощью которого вы можете назначить пользователю роли. Присвойте параметру roleId внутри массива ID нужной роли. Если вы назначаете две роли, одна из них — Обучающийся, а вторая — любая из административных ролей (Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками). Узнайте больше об использовании параметра roles в разделе Важно. |
Информация | ||||||
---|---|---|---|---|---|---|
Важно: Якорь |
Важная информация
|
...
Параметр | Тип | Описание |
---|---|---|
userId | string | ID добавленного пользователя. |
Возможные ошибки
Ошибка | Описание |
---|---|
User with the same email is already registered. | Пользователь с указанным email адресом уже существует. |
User with the same login is already registered. | Пользователь с указанным логином уже существует. |
Number of user accounts is exceeded | Превышено количество пользователей в учетной записи. Пользователь не был добавлен. |
Permission Denied | У пользователя недостаточно прав для выполнения запроса. Например, Администратор подразделения может добавить пользователя только в подразделения, которыми управляет, и во вложенные в него подразделения. |
Wrong parameters | Некоторые параметры заданы неверно. |
Пример запроса
Блок кода | ||
---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="httphttps://schemas.xmlsoap.org/soap/envelope/" xmlns="httphttps://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <AddUserRequest> <credentials> <accountUrl>http://myaccount.ispringlearn.ru</accountUrl> <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token> </credentials> <password>password</password> <email>email@email.ru<<sendLoginEmail>true</email>sendLoginEmail> <invitationMessage>Используйте следующие <password>password</password>данные, чтобы войти в Академию iSpring: </credentials>invitationMessage> <password>password<<sendLoginSMS>true</password>sendLoginSMS> <sendLoginEmail>true</sendLoginEmail><invitationSMSMessage>Используйте следующие данные, чтобы войти в Академию iSpring: <invitationMessage>message<</invitationMessage>invitationSMSMessage> <departmentId>string</departmentId> <role>custom</role> <roleId>928af650-af7e-11e9-9fa2-0a73fd48768b</roleId> <manageableDepartmentIds> <id>string</id> <id>string</id> </manageableDepartmentIds> <fields> <field> <name>login</name> <value>eivanova@ispring.ru</value> </field> </fields> <groups> <id>string</id> <id>string</id> </groups> <roles> <userRole> <roleId>eaf02558-2ae1-11e9-8b17-0242ac13000a</soap:roleId> </userRole> <userRole> <roleId>eaf01e14-2ae1-11e9-89a5-0242ac13000a</roleId> <manageableDepartmentIds> <id>8da0a5a4-b2a3-11e9-b20c-0a580af402f4</id> </manageableDepartmentIds> </userRole> </roles> </AddUserRequest> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
Пример Пример ответа
Блок кода | ||
---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="httphttps://schemas.xmlsoap.org/soap/envelope/" xmlns="httphttps://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <AddUserResult> <userId>b4a40e06-179e-11ea-a4a6-3a1aaf98af16<userId> </AddUserResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
...