Метод: addUser
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками.
Администратор подразделения или пользователь с ролью с индивидуальными настройками могут добавлять пользователей только в подразделения, которыми управляют, и в их дочерние подразделения.
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
email (необязательный) | string | Email пользователя, которого вы добавляете. |
login (обязательный) | string | Логин нового пользователя. |
password (необязательный) | string | Пароль пользователя, которого вы добавляете. |
departmentId (обязательный) | string | ID подразделения, в которое будет добавлен пользователь. |
sendLoginEmail (необязательный, по умолчанию: true) | bool | Параметр отвечает за отправку сообщения с данными пользователю. |
invitationMessage (необязательный) | string | Текст сообщения, который будет отображаться в письме. |
role (обязательный) | string | Если вы назначаете пользователю одну из стандартных ролей (кроме Владельца аккаунта и Автора), присвойте параметру role одно из следующих значений:
Если вы назначаете пользователю одну из ролей с индивидуальными настройками, присвойте параметру role значение custom. |
roleId (обязательный, если роль пользователя — publisher или роль с индивидуальными настройками) | string | Параметр roleId используется, если вы назначаете пользователю одну из ролей с индивидуальными настройками или роль Автора. |
manageableDepartmentIds (обязательный, если роль пользователя — department_administrator, publisher или роль с индивидуальными настройками) | string[] | Список ID подразделений, которыми будет управлять пользователь, если его роль — Администратор подразделения, Автор или роль с индивидуальными настройками. |
groups (необязательный) | string[] | Список ID групп, в которых будет состоять пользователь. |
Если в аккаунте есть обязательные поля пользовательского профиля (за исключением полей типа 'Cтрана'), их обязательно нужно указать в запросе.
Возвращаемые значения
Параметр | Тип | Описание |
---|---|---|
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="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <AddUserRequest> <credentials> <accountUrl>http://myaccount.ispringlearn.ru</accountUrl> <email>email@email.ru</email> <password>password</password> </credentials> <password>password</password> <sendLoginEmail>true</sendLoginEmail> <invitationMessage>message</invitationMessage> <departmentId>string</departmentId> <role>custom</role> <roleId>928af650-af7e-11e9-9fa2-0a73fd48768b</roleId> <fields> <field> <name>login</name> <value>eivanova@ispring.ru</value> </field> </fields> <groups> <id>string</id> <id>string</id> </groups> <manageableDepartmentIds> <id>string</id> <id>string</id> </manageableDepartmentIds> </AddUserRequest> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Пример ответа
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <AddUserResult> <userId>b4a40e06-179e-11ea-a4a6-3a1aaf98af16<userId> </AddUserResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>