ДОСТУПНО В BUSINESS ПОДПИСКЕ
Запрос: POST /group/{group_id}/members
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками, которые позволяют заменять участников группы.
Заголовки и параметры запроса
Заголовок | Описание |
|---|---|
| X-Auth-Account-Url (обязательный) | Базовый URL аккаунта, например, https://myaccount.ispringlearn.ru |
| X-Auth-Email (обязательный) | Логин Владельца аккаунта, Администратора аккаунта, Администратора подразделения или пользователя с ролью с индивидуальными настройками, которые позволяют заменять участников группы. |
| X-Auth-Password (обязательный) | Пароль Владельца аккаунта, Администратора аккаунта, Администратора подразделения или пользователя с ролью с индивидуальными настройками, которые позволяют заменять участников группы. |
| Параметр | Описание |
| group_id (обязательный) | ID группы, пользователей которой вы хотите заменить. |
| userIds (обязательный) | Массив пользователей, которых вы хотите добавить в группу. |
Переданные с помощью метода пользователи полностью заменяют состав группы. То есть, переданный и пустой параметр userIds удалит всех пользователей из группы. Если переданы ID двух пользователей, все ранее включенные в группу пользователи удалятся, а два новых пользователя добавятся.
Важно:
Допустим, Администратор подразделения или пользователь с ролью с индивидуальными настройками, которые позволяют заменять участников группы, отправили список новых пользователей, которых надо добавить в группу. В группе есть существующие пользователи - из управляемых ими подразделений и из подразделений, к которым они доступа не имеют.
После выполнения метода в группу добавятся новые пользователи, указанные в запросе, а удалятся только те, которые входят в состав подразделений, которыми Администратор подразделения или пользователь с ролью с индивидуальными настройками управляют, и их дочерних подразделений.
Пользователи, которые входят в состав подразделений, к которым Администратор подразделения или пользователь с ролью с индивидуальными настройками доступа не имеют, останутся в группе.
Коды ответов
Код | Текст | Описание |
|---|---|---|
| 200 | OK | Замена пользователей произошла успешно. |
| 400 | Bad Request | Ошибка в запросе. |
| 401 | Unauthorized | Ошибка авторизации. |
| 403 | Permission denied | У пользователя недостаточно прав для выполнения запроса. |
Пример запроса
POST /group/b1496214-acab-11e9-8db0-120a62f268a9/members https/1.1 Host: api-learn.ispringlearn.ru X-Auth-Account-Url: https://myaccount.ispringlearn.ru X-Auth-Email: email@email.com X-Auth-Password: password Content-Type:application/xml <?xml version="1.0" encoding="UTF-8"?> <request> <userIds> <id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id> </userIds> </request>
Пример ответа
https/1.1 200 OK