/api/v2/bpm/auth/login

Метод отвечает за аутентификацию пользователя в системе и выпуск пары токенов:

• Bearer access token действующий 3 минуты
• Refresh token, время действия которого до 30 минут

application/json

Request Body required

• login login

  Possible values: >= 4 characters and <= 64 characters, Value must match regular expression /^[\w.-]{4,64}$/g

  Логин пользователя.

• password password

  Possible values: >= 2 characters and <= 128 characters, Value must match regular expression ^[a-zA-Z\d!@#$%^&*()\-_+=;:,.\/?\\|~[]{}]{2,128}$`

  Пароль пользователя.

• device_id device_id

  Possible values: non-empty and <= 255 characters

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

• session string deprecated

  Possible values: non-empty and <= 255 characters

  Идентификатор сессии. Убран, так как не использовался.

Responses

• 200
• 400
• 401

---

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

Response Headers

• Set-Cookie string

  Cookie с access токеном

• Set-Cookie2 string

  Cookie с CSRF токеном

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• status integer required

  Possible values: [0, 1]

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

• message string nullable required

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

• response object required

  Объект с парой токенов.

  access access required

  Access токен.

  refresh refresh required

  Refresh токен.

• preparingsTime number required

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

{
  "status": 0,
  "message": "string",
  "response": {
    "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzIzMTEzOTQyLCJpYXQiOjE3MjMxMTIxNDIsImp0aSI6IjAyNThlYTY2YzgyYTRjZTNhYmI0OTBkMzY2Y2E3YWNjIiwiaWRfdXNlciI6MTM2NjkxN30.sKyjZW7zsvvIVcprGgrEmknAlDX_ckH06fK2hI2UhKY",
    "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcyMjk0OTE0NCwiaWF0IjoxNzIyOTQ4OTY0LCJqdGkiOiI3NzYzYmJlZWExYjI0MGRkYTJhY2NkNThhYTM5ODk2NSIsImlkX3VzZXIiOjEzNjY5MTd9.lydyYntPwnCCFZPdva4AeFYKZZSVOMSSRaX9PnBqdmg"
  },
  "preparingsTime": 0
}

{
  "status": 1,
  "message": "",
  "response": {
    "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzIzMTEzOTQyLCJpYXQiOjE3MjMxMTIxNDIsImp0aSI6IjAyNThlYTY2YzgyYTRjZTNhYmI0OTBkMzY2Y2E3YWNjIiwiaWRfdXNlciI6MTM2NjkxN30.sKyjZW7zsvvIVcprGgrEmknAlDX_ckH06fK2hI2UhKY",
    "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcyMzExMjMyMiwiaWF0IjoxNzIzMTEyMTQyLCJqdGkiOiJkYTlmZWQ3OTE0ZmQ0ZDVkOWI0YTg2ZDYwOWI5NGFjYiIsImlkX3VzZXIiOjEzNjY5MTd9.8kCeHICZ_GriMib2AITo_IowRrA9rCfdilEm-Ek_IDY"
  },
  "preparingsTime": 0.027
}

В теле запроса отсутсвуют обязательные свойства.

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• status integer required

  Possible values: [0, 1]

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

• message string nullable required

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

• response object required

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

  {{Название обязательного свойства}} string[] required

  Possible values: >= 1, <= 1

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

• preparingsTime number required

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

{
  "status": 0,
  "message": "string",
  "response": {
    "{{Название обязательного свойства}}": "This field is required."
  },
  "preparingsTime": 0
}

{
  "status": 0,
  "message": "This field is required.",
  "response": {
    "device_id": [
      "This field is required."
    ],
    "login": [
      "This field is required."
    ],
    "password": [
      "This field is required."
    ]
  },
  "preparingsTime": 0.001
}

Пользователь с указанным логином и паролем не найден.

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

  Код ошибки.

• preparingsTime number required

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

{
  "status": 0,
  "message": "string",
  "response": {
    "detail": "Token is invalid or expired",
    "code": "token_not_valid"
  },
  "preparingsTime": 0
}

{
  "status": 0,
  "message": "No active account found with the given credentials",
  "response": {
    "detail": "No active account found with the given credentials",
    "code": "no_active_account"
  },
  "preparingsTime": 0.01
}

Loading...