Метод: changeUserStatus
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
token (обязательный) | string | Токен доступа. Вы можете получить токен с помощью запроса |
userId (обязательный) | string | ID пользователя, профиль которого вы хотите изменить |
status (обязательный) | string | 1 - чтобы активировать пользователя, 3 - чтобы деактивировать пользователя |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками.
Администратор подразделения или пользователь с ролью с индивидуальными настройками могут активировать и деактивировать пользователей подразделений, которыми управляют, и их дочерние подразделений.
Возвращаемые значения
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|---|---|
success | bool | True, если пользователь активирован/деактивирован |
Возможные ошибки
Текст | Описание |
---|---|
Unknown user | Пользователь не найден |
Permission denied | Недостаточно прав для активации или деактивации пользователя |
User status must be 1 or 3, <status> given | Недопустимый статус |
Пример запроса
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <ChangeUserStatusRequest> <credentials> <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token> </credentials> <userId>string</userId> <status>1</status> </changeUserStatusRequest> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Пример ответа
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <ns1:successResult> <ns1:success>true</ns1:success> </ns1:successResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>