Дерево страниц

Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Метод: addUser

Права пользователя для выполнения запроса

Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками.

Администратор подразделения или пользователь с ролью с индивидуальными настройками могут добавлять пользователей только в подразделения, которыми управляют, и в их дочерние подразделения.

Параметры запроса

Параметр

Тип

Описание

credentials (обязательный)credentialsСмотрите описание объекта Credentials.
email (необязательный)stringEmail пользователя, которого вы добавляете.
login (обязательный)stringЛогин нового пользователя.
password (необязательный)stringПароль пользователя, которого вы добавляете.
departmentId (обязательный)stringID подразделения, в которое будет добавлен пользователь.

sendLoginEmail (необязательный, по умолчанию: true)

boolПараметр отвечает за отправку сообщения с данными пользователю.
invitationMessage (необязательный)stringТекст сообщения, который будет отображаться в письме.
role (обязательный)string

Если вы назначаете пользователю одну из стандартных ролей (кроме Владельца аккаунта и Автора), присвойте параметру role одно из следующих значений:

  • learner
  • department_administrator
  • administrator

Если вы назначаете пользователю одну из ролей с индивидуальными настройками, присвойте параметру role значение custom.

roleId (обязательный, если роль пользователя — publisher или роль с индивидуальными настройками)stringПараметр roleId используется, если вы назначаете пользователю одну из ролей с индивидуальными настройками или роль Автора.
manageableDepartmentIds (обязательный, если роль пользователя — department_administrator, publisher или роль с индивидуальными настройками)string[]

Список ID подразделений, которыми будет управлять пользователь, если его роль — Администратор подразделения, Автор или роль с индивидуальными настройками.

groups (необязательный)string[]Список ID групп, в которых будет состоять пользователь.

Права пользователя для выполнения запроса

Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками.

...


Информация

Если в аккаунте есть обязательные поля пользовательского профиля (за исключением полей типа 'Cтрана'), их обязательно нужно указать в запросе.

Возвращаемые значения

Параметр

Тип

Описание

userIdstringID добавленного пользователя.

...