ДОСТУПНО В BUSINESS ПОДПИСКЕ
Метод: deactivateUsers
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками.
Администратор подразделения или пользователь с ролью с индивидуальными настройками могут активировать и деактивировать пользователей подразделений, которыми управляют, и их дочерние подразделений.
Параметры запроса
Параметр | Тип | Описание |
|---|---|---|
| credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
| userIds (обязательный) | array | Массив ID пользователей, статус которых вы хотите изменить. |
Возвращаемые значения
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
|---|---|---|
| success | bool | True, если пользователь активирован/деактивирован. |
Возможные ошибки
Текст | Описание |
|---|---|
| Unknown user | Пользователь не найден. |
| Permission denied | Недостаточно прав для активации или деактивации пользователя. |
Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.com/go/services/api/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:DectivateUsersRequest>
<soap:credentials>
<soap:accountUrl>https://myaccount.ispringlearn.com</soap:accountUrl>
<soap:email>admin@company.com</soap:email>
<soap:password>password</soap:password>
</soap:credentials>
<soap:userIds>
<!--Zero or more repetitions:-->
<soap:id>32bd7dc6-a7cb-11ed-b640-92a80c30e0de</soap:id>
<soap:id>887c4dfc-4806-11ed-aa3d-dec5838cbd40</soap:id>
</soap:userIds>
</soap:ActivateUsersRequest>
</soapenv:Body>
</soapenv:Envelope>
Пример ответа
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<ns1:SuccessResult>
<ns1:success>true</ns1:success>
</ns1:SuccessResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>