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

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

POST /users/{userId}/force-logout

Описание

Принудительно завершает сессию пользователя, требуя смену пароля при следующем входе.

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

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

Название	Обязательный	Тип данных	Описание
userId	да	string	Идентификатор пользователя
requirePasswordChange	да	boolean	Требовать смену пароля при следующем входе

Запрос

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

Где:

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

Ответ

200 — Basic API response with success status — Пользователь принудительно вышел. Пример вывода:

{
  "success": true
}