Метод: addUser
Вы можете добавить пользователя в систему с помощью метода addUser.
Права пользователя для выполнения запроса: Владелец аккаунта, Администратор, Администратор подразделения.
Администратор подразделения может добавлять пользователей только в свое подразделение и во вложенные в него подразделения.
Параметры запроса
Параметр | Тип | Описание |
|---|---|---|
| credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
| email (необязательный) | string | Email пользователя, которого вы добавляете. |
| login (обязательный) | string | Логин нового пользователя. |
| password (необязательный) | string | Пароль пользователя, которого вы добавляете. |
| departmentId (обязательный) | string | ID подразделения, в которое будет добавлен пользователь. |
sendLoginEmail (необязательный, по умолчанию: true) | bool | Параметр отвечает за отправку сообщения с данными пользователю. |
| invitationMessage (необязательный) | string | Текст сообщения, который будет отображаться в письме. |
| role (обязательный) | string | Пользователю может быть присвоена одна из следующих ролей: learner |
| groups (необязательный) | string[] | Список ID групп, в которых будет состоять пользователь. |
| manageableDepartmentIds (обязательный, если роль пользователя — department_administrator или publisher) | string[] | Список ID подразделений, которыми будет управлять пользователь, если его роль — администратор подразделения или автор. |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор, Администратор подразделения.
Администратор подразделения может добавлять пользователей только в свое подразделение и во вложенные в него подразделения.
Возвращаемые значения
Параметр | Тип | Описание |
|---|---|---|
| userId | string | ID добавленного пользователя. |
...