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

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

ДОСТУПНО В BUSINESS ПОДПИСКЕ

Запрос: POST /user/{user_id}/groups/remove

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

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

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

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

Заголовок

Описание

Authorization (обязательный)

Токен доступа. Вы можете получить токен с помощью запроса
ПараметрОписание
user_id (обязательный)ID пользователя, который будет исключен из групп
groupIds (обязательный)Список ID групп, из которых будет исключен пользователь

Коды ответов

Код

Текст

Описание

204OKУказанный пользователь удален
400Bad RequestОшибка в запросе
401UnauthorizedОшибка авторизации
403Permission DeniedУ пользователя недостаточно прав для выполнения запроса

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

POST /user/6c45a8ca-c0ae-11ec-89d5-0242c0a8a039/groups/remove
Host: api-learn.ispringlearn.ru 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE 
 
<?xml version="1.0" encoding="UTF-8"?>
<request>
    <groupIds>
        <id>c400156e-b9a6-11ec-b941-0242c0a8a039</id>
        <id>9eebd6c0-d524-11ec-be4f-0242ac150039</id>
    </groupIds>
</request>

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

POST /user/6c45a8ca-c0ae-11ec-89d5-0242c0a8a039/groups/remove
Host: api-learn.ispringlearn.ru 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
   
 {
  "groupIds": [
    "c400156e-b9a6-11ec-b941-0242c0a8a039",
    "9eebd6c0-d524-11ec-be4f-0242ac150039"
  ]
}

Пример запроса в curl - JSON

curl -X 'POST' \
  'https://api-learn.ispring.lan/user/6c45a8ca-c0ae-11ec-89d5-0242c0a8a039/groups/remove' \
  -H 'accept: */*' \
  -H 'Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE' \
  -H 'Content-Type: application/json' \
  -d '{
  "groupIds": [
    "c400156e-b9a6-11ec-b941-0242c0a8a039",
    "9eebd6c0-d524-11ec-be4f-0242ac150039"
  ]
}'

Пример запроса в curl - XML

curl -X 'POST' \
  'https://api-learn.ispring.lan/user/6c45a8ca-c0ae-11ec-89d5-0242c0a8a039/groups/remove' \
  -H 'accept: */*' \
  -H 'Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE' \
  -H 'Content-Type: application/xml' \
  -d '<?xml version="1.0" encoding="UTF-8"?>
<request>
    <groupIds>
            <id>c400156e-b9a6-11ec-b941-0242c0a8a039</id>
            <id>9eebd6c0-d524-11ec-be4f-0242ac150039</id>
    </groupIds>
</request>'

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

https/1.1 204 OK
  • Нет меток