/api/v2/bpm/auth/logout

Метод отвечает за деактивацию refresh токенов пользователя, привязанных к определённому устройству пользователя.

Невозможно деактивировать токены, принадлежащие другому пользователю. Если передан несуществующий идентификатор пользователя, метод все равно вернёт 200.

application/json

Request Body required

• device_id device_id

  Possible values: non-empty and <= 255 characters

  Уникальный идентификатор устройства. Для панели администратора используется автоматически генерируемый UUID.

Responses

• 200
• 401

---

Успешный ответ.

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• status integer required

  Possible values: [0, 1]

  Статус отработки запроса.
  1 - Успех
  0 - Ошибка

• message string nullable required

  Сообщение ответа.

• response object required
• preparingsTime number required

  Время подготовки ответа сервером без учёта сети.

{
  "status": 0,
  "message": "string",
  "response": {},
  "preparingsTime": 0
}

{
  "status": 1,
  "message": "Logout success",
  "response": {},
  "preparingsTime": 0.015
}

Ошибка авторизации запроса.

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• status integer required

  Possible values: [0, 1]

  Статус отработки запроса.
  1 - Успех
  0 - Ошибка

• message string nullable required

  Описание ошибки.

• response object required

  Объект с детализацией ошибки.

  detail string required

  Детальное описание ошибки.

  code string required

  Код ошибки.

  messages object[] required

  Possible values: <= 1, >= 1

  Массив сообщений.

  Array [

  token_class string required

  Класс токена.

  token_type string required

  Тип токена.

  message string required

  Сообщение об ошибке.

  ]
• preparingsTime number required

  Время подготовки ответа сервером без учёта сети.

{
  "status": 0,
  "message": "Given token not valid for any token type",
  "response": {
    "detail": "Given token not valid for any token type",
    "code": "token_not_valid",
    "messages": [
      {
        "token_class": "AccessToken",
        "token_type": "access",
        "message": "Token is invalid or expired"
      }
    ]
  },
  "preparingsTime": 0
}

{
  "status": 0,
  "message": "Given token not valid for any token type",
  "response": {
    "detail": "Given token not valid for any token type",
    "code": "token_not_valid",
    "messages": [
      {
        "token_class": "AccessToken",
        "token_type": "access",
        "message": "Token is invalid or expired"
      }
    ]
  },
  "preparingsTime": 0.012
}

Loading...