Вы можете добавить пользователя в систему с помощью метода addUser.
Права пользователя для выполнения запроса: владелец аккаунта, администратор, администратор организации.
Параметры
Параметр | Тип | Описание |
---|---|---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
email (обязательный) | string | Email пользователя, которого вы добавляете. |
login (необязательный) | string | Логин нового пользователя. |
password (необязательный) | string | Пароль пользователя, которого вы добавляете. |
organizationId (необязательный) | string | ID организации, в которую будет добавлен пользователь. |
sendLoginEmail (необязательный, по умолчанию: true) | bool | Параметр отвечает за отправку сообщения с данными пользователю. |
invitationMessage (необязательный) | string | Текст сообщения, который будет отображаться в письме. |
role (необязательный) | string | Права нового пользователя: 10 - обычный пользователь, 20 - автор, 30 - администратор организации, 40 - администратор аккаунта. |
groups (необязательный) | string[] | Список ID групп, в которые будет добавлен пользователь. |
Возвращаемые значения
Параметр | Тип | Описание |
---|---|---|
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="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<AddUserRequest>
<credentials>
<accountUrl>http://myaccount.ispringonline.ru</accountUrl>
<email>email@email.ru</email>
<password>password</password>
</credentials>
<email>user@email.com</email>
<password>password</password>
<sendLoginEmail>true</sendLoginEmail>
<invitationMessage>message</invitationMessage>
<role>20</role>
<groups>
<id>1</id>
<id>2</id>
</groups>
</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>1<userId>
<exceededGroups />
</AddUserResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |