Включить страницу |
---|
| Лэйблы с указанием тарифа |
---|
| Лэйблы с указанием тарифа |
---|
|
Метод: addUser
...
Права пользователя для выполнения запроса
...
Параметры запроса
...
credentials credentials | Смотрите описание объекта Credentials.обязательныйнеобязательный) | string | Email пользователя, которого вы добавляете |
.необязательныйобязательный) | string | Логин нового пользователя |
. |
password (необязательный) | string | Пароль пользователя, которого вы добавляете |
.organizationId необязательный организации которую которое будет добавлен пользователь |
. |
sendLoginEmail (необязательный, по умолчанию: |
true false) | bool | Параметр отвечает за отправку сообщения с данными пользователю |
.invitationMessage (необязательный |
invitationMessage (обязательный, если в параметре sendLoginEmail указано значение true) | string | Текст email-сообщения, которое отправляется добавленному пользователю |
sendLoginSMS (необязательный, по умолчанию: false) | bool | Параметр отвечает за отправку SMS с данными пользователю |
invitationSMSMessage (обязательный, если в параметре sendLoginSMS указано значение true) | string | Текст |
сообщения, который будет отображаться в письме.SMS, которое отправляется добавленному пользователю |
role (необязательный) | string |
Права нового пользователя: 10 - обычный пользователь, 20 - автор, 30 - администратор организации, 40 - администратор аккаунта. | Если вы назначаете пользователю одну из стандартных ролей (кроме Владельца аккаунта и Автора), присвойте параметру role одно из следующих значений: - administrator,
- department_administrator,
- learner.
Если вы назначаете пользователю роль Автора или одну из ролей с индивидуальными настройками, присвойте параметру role значение custom.
Узнайте больше об использовании параметра role в разделе Важно
|
roleId (обязательный, если в параметре role указано значение custom) | string | Параметр roleId используется, если вы назначаете пользователю роль Автора или одну из ролей с индивидуальными настройками. В этом случае присвойте параметру roleId ID нужной роли.
Узнайте больше об использовании параметра roleId в разделе Важно
|
manageableDepartmentIds (обязательный, если роль пользователя — department_administrator, publisher или роль с индивидуальными настройками) | string[] | Список ID подразделений, которыми будет управлять пользователь, если его роль — Администратор подразделения, Автор или роль с индивидуальными настройками |
groups |
groups (необязательный) | string[] | Список ID групп, в которых будет состоять пользователь |
roles (необязательный) | string[] | Массив данных, с помощью которого вы можете назначить пользователю роли. Присвойте параметру roleId внутри массива ID нужной роли.
Если вы назначаете две роли, одна из них — Обучающийся, а вторая — любая из административных ролей (Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками).
Узнайте больше об использовании параметра roles в разделе Важно |
Информация |
---|
Важная информация- Если в аккаунте есть обязательные поля пользовательского профиля (за исключением полей типа 'Cтрана'),
|
...
- их обязательно нужно указать в запросе.
- Роль для пользователя можно задать двумя способами:
- при помощи тегов role (если роль — Администратор аккаунта, Администратор подразделения или Обучающийся) и roleId (если роль — Автор или роль с индивидуальными настройками),
- при помощи массива данных roles.
- Если для назначения роли пользователю вы используете массив данных roles, вы сможете выбрать две роли сразу.
Одна из ролей — Обучающийся, вторая — любая из административных ролей (Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками).
Если в массиве данных roles вы укажете две административные роли, пользователь не добавится.
- Если вы указали роль для пользователя одновременно с помощью тегов role/roleId и массива данных roles, пользователю будет назначена роль или роли, указанные в массиве данных roles.
Значение, указанное в теге role/roleId, в этом случае будет проигнорировано.
- Если вы не указали роль пользователя ни с помощью тегов role/roleId, ни с помощью массива данных roles, создастся пользователь с ролью Обучающийся.
|
Возвращаемые значения
Параметр | Тип | Описание |
---|
userId | string | ID добавленного пользователя |
.exceededGroups | 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>
<token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
</credentials>
<password>password</password>
<sendLoginEmail>true</sendLoginEmail>
<invitationMessage>Используйте следующие данные, чтобы войти в Академию iSpring:
</invitationMessage>
<sendLoginSMS>true</sendLoginSMS>
<invitationSMSMessage>Используйте следующие данные, чтобы войти в Академию <accountUrl>http://myaccount.ispringonline.ru</accountUrl>
iSpring:
</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>
<email>email@email<value>eivanova@ispring.ru</email>value>
<password>password<</password>field>
</credentials>/fields>
<groups>
<id>string</id>
<email>user@email.com</email> <id>string</id>
<password>password</password></groups>
<roles>
<userRole>
<sendLoginEmail>true</sendLoginEmail> <roleId>eaf02558-2ae1-11e9-8b17-0242ac13000a</soap:roleId>
<invitationMessage>message</invitationMessage> </userRole>
<userRole>
<role>20</role>
<roleId>eaf01e14-2ae1-11e9-89a5-0242ac13000a</roleId>
<groups> <manageableDepartmentIds>
<id>1< <id>8da0a5a4-b2a3-11e9-b20c-0a580af402f4</id>
</manageableDepartmentIds>
<id>2</id></userRole>
</groups>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>1<userId>
<exceededGroups /><userId>b4a40e06-179e-11ea-a4a6-3a1aaf98af16<userId>
</AddUserResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |