Удаление пользователя

Метод и конечная точка

DELETE /users/{userId}

Описание

Удаление существующего пользователя. Требуются разрешения на удаление пользователей.

Параметры пути

Перечень параметров представлен в таблице.

Название	Обязательный	Тип данных	Описание
userId	да	string	Идентификатор пользователя для удаления
confirmRelinquish	нет	boolean	Подтверждение удаления (принудительное удаление)

Запрос

curl -X 'DELETE' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/users/<USER_ID_TO_DELETE>' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>' \
  -d '{ \
  "confirmRelinquish": true
  }'

Где:

• <ENV> — окружение, на котором выполняется запрос;
• <DEFAULT_DOMAIN> — домен сервера Squadus;
• <USER_ID_TO_DELETE> — идентификатор пользователя, которого необходимо удалить;
• <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
• <AUTH_TOKEN> — токен аутентификации пользователя.

Ответ

200 — Delete user response — Пользователь удален. Пример вывода:

{
  "success": true
}