iSpring Port

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

Запрос: POST /user

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

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

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

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

Заголовок

Описание

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 в разделе Важно

Параметры ответа

Параметр

Описание

user_id

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

Важная информация

  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У пользователя нет прав для добавления. Например, Администратор подразделения не может добавить пользователя в подразделение, которым не управляет

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

POST /user https/1.1
Host: api-learn.ispringlearn.ru 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE 
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8"?>
<request>
    <departmentId>1b7270ce-5cf5-11e9-a78e-0a580af40692</departmentId>
    <password>password v2</password>
    <fields>   
       <login>ekaterina.ivanova</login>
       <phone>+79101231232</phone>
       <email>eivanova@ispring.ru</email>
       <first_name>Екатерина</first_name>
       <last_name>Иванова</last_name>
       <job_title>Менеджер по продажам</job_title>
    </fields>   
    <role>custom</role>
    <roleId>928af650-af7e-11e9-9fa2-0a73fd48768b</roleId>
    <manageableDepartmentIds>
        <id>b00ba37c-5b6f-11e9-bb45-0a580af40556</id>
        <id>aff46554-5b6f-11e9-80e4-0a580af40556</id>
    </manageableDepartmentIds>
    <groupIds>
        <id>270ebbfa-5f6f-11e9-878e-0a580af406fd</id>
    </groupIds>
    <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>
    <sendLoginEmail>true</sendLoginEmail>
    <invitationMessage>Используйте следующие данные, чтобы войти в Академию iSpring:
    </invitationMessage>
    <sendLoginSMS>true</sendLoginSMS>
    <invitationSMSMessage>Используйте следующие данные, чтобы войти в Академию iSpring:
    </invitationSMSMessage>
</request>

Пример ответа

https/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<response>{user_id string}</response>