Изменяйте состав группы с помощью POST метода, отправленного на URL /group/{group_id}/members.
Роль пользователя для выполнения запроса: Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками, которые позволяют заменять участников группы.
Параметры запроса
Заголовок | Описание |
|---|---|
| X-Auth-Account-Url (обязательный) | Базовый URL аккаунта, например, http://my.ispringlearn.ru |
| X-Auth-Email (обязательный) | Логин Логин Владельца аккаунта, Администратора Администратора или Администратора подразделения. |
| X-Auth-Password (обязательный) | Пароль Пароль Владельца аккаунта, Администратора Администратора или Администратора подразделения. |
| Параметр | Описание |
| group_id (обязательный) | ID группы, пользователей которой вы хотите заменить. |
| name (необязательный) | Название группы, пользователей которой вы хотите заменить. |
| Подсказка |
|---|
Переданные с помощью метода пользователи полностью заменяют состав группы. То есть, переданный и пустой параметр userIds удалит всех пользователей из группы. Если переданы ID двух пользователей, все ранее включенные в группу пользователи удалятся, а два новых пользователя добавятся. Важно: если Допустим, Администратор подразделения или пользователь с ролью с индивидуальными настройками, которые позволяют заменять участников группы, Администратор подразделения или Автор отправили список новых пользователей, которых надо добавить в группу. В группе есть существующие пользователи - из управляемых ими подразделений и из подразделений, к которым они доступа не имеют. После выполнения метода в группу добавятся новые пользователи, указанные в запросе, а , из существующих пользователей удалятся только те, которые которые входят в состав подразделений, которыми данный Администратор подразделения или Автор или пользователь с ролью с индивидуальными настройками управляют, или и их дочерних подразделений. Пользователи, которые входят в состав подразделений, к которым Администратор подразделения или пользователь с ролью с индивидуальными настройками доступа не имеют, останутся в группе. |
Коды ответов
Код | Текст | Описание |
|---|---|---|
| 200 | Successful operation | Параметр успешно изменен. |
| 400 | Bad Request | Ошибка в запросе. |
| 401 | Unauthorized | Ошибка авторизации. |
| 403 | Permission denied | У пользователя недостаточно прав для выполнения запроса. |
Пример запроса
| Блок кода | ||
|---|---|---|
| ||
POST /group/b1496214-acab-11e9-8db0-120a62f268a9/members HTTP/1.1 Host: api-learn.ispringlearn.ru X-Auth-Account-Url: http://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> |
Пример ответа
| Блок кода | ||
|---|---|---|
| ||
HTTP/1.1 200 Successful operation Connection: close |
...