Метод: RemoveUserFromGroups
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор, Администратор подразделения или роль с индивидуальными настройками.
Администратор подразделения или пользователь с ролью с индивидуальными настройками может удалять пользователей только в своем подразделении и во вложенных в него подразделениях.
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
token (required) | string | Токен доступа. Вы можете получить токен с помощью запроса |
userId (required) | string | ID пользователя, который будет исключен из групп |
Возвращаемые значения
Если запрос успешно обработан, система возвращает объект со следующими свойствами.
Параметр | Тип | Описание |
---|---|---|
success | bool | True, если пользователь удален |
Ошибки
Ошибка | Описание |
---|---|
Unknown user | Пользователь с данным ID не найден |
Permission Denied | Недостаточно прав для удаления выбранного пользователя |
Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.ru/go/services/api/soap"> <soapenv:Header/> <soapenv:Body> <soap:RemoveUserFromGroupsRequest> <soap:credentials> <soap:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</soap:token> </soap:credentials> <soap:userId>6c45a8ca-c0ae-11ec-89d5-0242c0a8a039</soap:userId> <soap:groupIds> <!--Zero or more repetitions:--> <soap:id>c400156e-b9a6-11ec-b941-0242c0a8a039</soap:id> <soap:id>9eebd6c0-d524-11ec-be4f-0242ac150039</soap:id> </soap:groupIds> </soap:RemoveUserFromGroupsRequest> </soapenv:Body> </soapenv:Envelope>
Пример ответа
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://ispringlearn.ru/go/services/api/soap"> <SOAP-ENV:Body> <ns1:SuccessResult> <ns1:success>true</ns1:success> </ns1:SuccessResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>