Документация по iSpring Learn

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

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

Старая версия 24

changes.mady.by.user admin

Сохранено

по сравнению с

Новая версия 25

changes.mady.by.user admin

Сохранено

Ключ

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

...

Параметр

Тип

Описание

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

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

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

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

  • learneradministrator
  • department_administratoradministrator
  • learner

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

Узнайте больше об использовании параметра role в разделе Важно.

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

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

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

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

Если вы назначаете две роли, одна из них — Обучающийся, а вторая — любая из административных ролей (Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками).

Узнайте больше об использовании параметра roles в разделе Важно.


Информация

Якорь
Важно
Важно
Важно: 

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

  2. Роль для пользователя можно задать двумя способами:
    1.  при помощи тегов <role> (если роль — Администратор аккаунта, Администратор подразделения или Обучающийся) и <roleId> (если роль — Автор или роль с индивидуальными настройками),

    2. при помощи массива данных <roles>.

  3. Если для назначения роли пользователю вы используете массив данных <roles>, вы сможете выбрать две роли сразу.

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

    Если в массиве <roles> вы укажете две административные роли, пользователь не добавится. 

  4. Если вы указали роль для пользователя одновременно с помощью тегов <role>/<roleId> и массива данных <roles>, пользователю будет назначена роль или роли, указанные в массиве данных <roles>.

    Значение, указанное в теге <role>/<roleId>, в этом случае будет проигнорировано.

  5. Если вы не указали роль пользователя ни с помощью тегов <role>/<roleId>, ни с помощью массива данных <roles>, создастся пользователь с ролью Обучающийся.

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

Параметр

Тип

Описание

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

...