Дерево страниц

ДОСТУПНО В BUSINESS ПОДПИСКЕ

Метод: deleteUser

Параметры запроса

ПараметрТипОписание
token (required)stringТокен доступа. Вы можете получить токен с помощью запроса
userId (required)stringID пользователя, которого вы хотите удалить

Права пользователя для выполнения запроса

Владелец аккаунта, Администратор, Администратор подразделения или роль с индивидуальными настройками.

Администратор подразделения или пользователь с ролью с индивидуальными настройками может удалять пользователей только в своем подразделении и во вложенных в него подразделениях.

Возвращаемые значения

Если запрос успешно обработан, система возвращает объект со следующими свойствами. 

ПараметрТипОписание
successboolTrue, если пользователь удален

Ошибки

ОшибкаОписание
Unknown userПользователь с данным ID не найден
Permission DeniedНедостаточно прав для удаления выбранного пользователя

Пример запроса

<?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>
    <DeleteUserRequest>
      <credentials>
        <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
      </credentials>
      <userId>string</userId>
    </DeleteUserRequest>
  </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="https://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <DeleteUserResult>
      <success>true</success>
    </DeleteUserResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>