POST
http://<server_address>/authentication
Данный метод позволяет генерировать токен сессии для пары логин/пароль. Для этого необходимо в теле запроса передать объект авторизации.
Запрос
Заголовки
| Имя заголовка | Тип данных | Описание | Обязательный | Значение по умолчанию |
|---|---|---|---|---|
| Content-Type | string | Тип передаваемых данных в запросе | Да | application/json |
Тело запроса
В теле запроса передается объект авторизации, который содержит в себе пару имя пользователя и его пароля.
Пример запроса
{
"UserName": "string",
"Password": "string"
}
Описание полей:
| Имя поля | Тип данных | Описание | Обязательный |
|---|---|---|---|
| UserName | string | Имя пользователя | Да |
| Password | string | Пароль пользователя | Да |
Ответы сервера
Данный код возвращается в том случае, если авторизация прошла успешно.
Пример ответа
{
"Id": "string",
"LifeTime": 0,
"StartedAt": "string"
}
Описание полей:
| Имя поля | Тип данных | Описание | Обязательный |
|---|---|---|---|
| Id | UUID | Идентификатор токена | Да |
| LifeTime | int32 | Время жизни токена в секундах | Да |
| StartedAt | datetime | Дата создания токена | Да |
Данный код возвращается в том случае, если переданный объект авторизации имел корректную структуру, но пара пользователь/пароль не верные.
Данный код возвращается в том случае, если не был передан объект авторизации или его содержимое некорректно.