...
Параметры запроса
Параметр | Тип | Описание | |
---|---|---|---|
credentials Authorization (обязательный) | credentials | string | Токен доступа. Вы можете получить токен с помощью запросаСмотрите описание объекта Credentials. |
email (необязательный) | string | Email пользователя, которого вы добавляете. | |
login (обязательный) | string | Логин нового пользователя. | |
password (необязательный) | string | Пароль пользователя, которого вы добавляете. | |
departmentId (обязательный) | string | ID подразделения, в которое будет добавлен пользователь. | |
sendLoginEmail (необязательный, по умолчанию: false) | bool | Параметр отвечает за отправку сообщения с данными пользователю. | |
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 групп, в которых будет состоять пользователь. | |
roles (необязательный) | string[] | Массив данных, с помощью которого вы можете назначить пользователю роли. Присвойте параметру roleId внутри массива ID нужной роли. Если вы назначаете две роли, одна из них — Обучающийся, а вторая — любая из административных ролей (Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками). Узнайте больше об использовании параметра roles в разделе Важно. |
...