iSpring Port

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

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

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

changes.mady.by.user elena.antipova

Сохранено

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

Новая версия Текущий

changes.mady.by.user Alina Levitskaya

Сохранено

Ключ

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

...

Заголовок

Описание

Authorization (обязательный)Токен доступа. Вы можете получить токен с помощью запроса
ПараметрОписание
email (необязательный)Email пользователя, которого вы добавляете
login (обязательный)Логин нового пользователя
password (необязательный)Пароль пользователя, которого вы добавляете
departmentId (обязательный)ID подразделения, в которое будет добавлен пользователь

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

Параметр отвечает за отправку сообщения с данными пользователю
invitationMessage (обязательный, если в параметре sendLoginEmail указано значение true)Текст email-сообщения, которое отправляется добавленному пользователю
sendLoginSMS (необязательный, по умолчанию: false)Параметр отвечает за отправку SMS с данными пользователю
invitationSMSMessage (обязательный, если в параметре sendLoginSMS указано значение true)Текст SMS, которое отправляется добавленному пользователю
role (необязательный)

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

  • learner,
  • department_administrator,
  • administrator.

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

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

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

Узнайте больше об использовании параметра roleId в разделе Важно
manageableDepartmentIds (обязательный, если роль пользователя — Администратор аккаунта, Автор или роль с индивидуальными настройками)Список ID подразделений, которыми будет управлять пользователь, если его роль — Администратор подразделения, Автор или роль с индивидуальными настройками.
groups (необязательный)Список ID групп, в которых будет состоять пользователь.
roles  (необязательный)

Массив данных, с помощью которого вы можете назначать пользователю одну или две роли. Присвойте параметру roleId внутри массива ID нужной роли.

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

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

...

Информация

Якорь
Важно
Важно
Важная информация

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

  2. Роль для пользователя можно задать двумя способами:

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

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

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

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

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

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

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

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

Коды ответов

Код

Текст

Описание

200OKПользователь добавлен. Тело ответа будет содержать ID добавленного пользователя
400Bad RequestОшибка в запросе
401UnauthorizedОшибка авторизации
403Permission DeniedУ пользователя нет прав для добавления. Например, Администратор подразделения не может добавить пользователя в подразделение, которым не управляет

...