iSpring Port

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

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

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

changes.mady.by.user Алина Задина

Сохранено

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

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

changes.mady.by.user Alina Levitskaya

Сохранено

Ключ

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

...

Заголовки и параметры запроса

X-Auth-Account-Url .. Передается .Фамилия пользователя Передается . Передается . ID групп. Обучающийся.. 

Заголовок

Описание

Authorization (обязательный)Базовый URL аккаунта, например, https://myaccount.ispringlearn.ru
X-Auth-Email (обязательный)Логин Владельца аккаунта, Администратора, Администратора подразделения или пользователя с ролью с индивидуальными настройками.
X-Auth-Password (обязательный)Пароль Владельца аккаунта, Администратора, Администратора подразделения или пользователя с ролью с индивидуальными настройками.
Токен доступа. Вы можете получить токен с помощью запроса
ПараметрОписание
user_id (обязательный)ID пользователя, профиль которого вы хотите изменить
email (необязательный)Email пользователя. Передается не отдельным параметром, а в составе fields
login (необязательный)Логин пользователя. Передается не отдельным параметром, а в составе fields.
first_name (необязательный)Имя пользователя. Передается не отдельным параметром, а в составе fields
last_name (необязательный)

Фамилия пользователя.

Передается не отдельным параметром, а в составе fields

job_title (необязательный)Должность пользователя. Передается не отдельным параметром, а в составе fields
departmentId (необязательный)ID подразделения, в котором состоит пользователь.
role (необязательный)

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

  • learner,
  • department_administrator,
  • administrator.

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

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

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

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

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

Узнайте больше об использовании параметра roles в разделе Важно
about_me (необязательный)Информация о пользователе в поле «О себе»


Информация

Важно

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

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

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

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

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

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

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

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

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

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

Коды ответов

Код

Текст

Описание

200OKПрофиль пользователя изменен.
400Bad RequestОшибка в запросе.
401UnauthorizedОшибка авторизации.
403Permission DeniedУ пользователя недостаточно прав для обновления профиля пользователя.

Пример запроса

Блок кода
languagexml
POST /user/43f4a84c-6280-11e9-8686-a6210366ac32 https/1.1
Host: api-learn.ispringlearn.ru
X-Auth-Account-Url: https://myaccount.ispringlearn.ru
X-Auth-Email: user
X-Auth-Password: password
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8"?>
<request>
	<fields>
      <login>ekaterina.ivanova</login>
      <email>eivanova@ispring.ru</email>
      <first_name>Екатерина</first_name>
      <last_name>Иванова</last_name>
      <job_title>Менеджер по продажам</job_title>
    </fields>  
	<departmentId>3fa85f64-5717-4562-b3fc-2c963f66afa6</departmentId>
	<groupIds>
		<id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
	</groupIds>
	<role>department_administrator</role>
	<manageableDepartmentIds>
		<id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
	</manageableDepartmentIds>
    <roles>
       <role>
         <roleId>efb18a8e-7be7-11ea-a17c-9e2d25e528cc</roleId>
            <manageableDepartmentIds>
                 <id>783eee2e-7b51-11ea-ae7d-9e2d25e528cc</id>
            </manageableDepartmentIds> 
       </role>  
       <role>
          <roleId>eaf02558-2ae1-11e9-8b17-0242ac13000a</roleId>  
       </role>  
    </roles>
    <about_me>Помогаю новичкам стартовать в продажах и быстро входить в ритм</about_me>
 </request>

...