Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Запрос

...

Заголовки

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

...

Даapplication/json

...

...


Тело запроса

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

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

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

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

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

Viewport Tabs Container
Viewport Tab
title200

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

Code Block
languagejs
titleПример ответа
{
  "Id": "string",
  "LifeTime": 0,
  "StartedAt": "string"
}

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

Имя поляТип данныхОписаниеОбязательный
IdUUIDИдентификатор токенаДа
LifeTimeint32Время жизни токена в секундахДа
StartedAtdatetimeДата создания токенаДа
Viewport Tab
title403

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

Viewport Tab
title405

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