You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »


POST
http://<server_address>/api/login

Данный метод позволяет генерировать токен сессии для пары логин/пароль. Для этого необходимо в теле запроса передать объект авторизации.

Запрос

Заголовки

Имя заголовкаТип данныхОписаниеОбязательныйЗначение по умолчанию
Content-TypestringТип передаваемых данных в запросеДаapplication/json


Тело запроса

В теле запроса передается объект авторизации, который содержит в себе пару имя пользователя и его пароля.

Пример запроса
{
  "UserName": "string",
  "Password": "string"
}

Описание полей:

Имя поляТип данныхОписаниеОбязательный
UserNamestringИмя пользователяДа
PasswordstringПароль пользователяДа

Ответы сервера

Данный код возвращается в том случае, если авторизация прошла успешно.

Пример ответа
{
        "username": string,
        "tokenPair": {
            "accessToken": string,
            "refreshToken": string
        }}

Описание полей:

Имя поляТип данныхОписаниеОбязательный
usernamestringИмя пользователяДа
accessTokenstringТокен доступаДа
refreshTokenstringТокен пролонгацииДа

Данный код возвращается в том случае, если переданный объект авторизации имел корректную структуру, но пара пользователь/пароль не верные.

Данный код возвращается в том случае, если не был передан объект авторизации или его содержимое некорректно.


  • No labels