Перейти к основному содержимому

Войти по логину и паролю

POST 
/v5/auth/sign-in

Коды возможных ошибок:​

[500]: "InternalServerError" - внутренняя ошибка сервера [429]: "TooManyRequests" - превышено ограничение на количество запросов в секунду [422]: "RequestIsNotValid" - параметры запроса не прошли валидацию [401]: "WrongUsernameOrPassword" - неверный логин или пароль

Request​

Header Parameters

    Accept-Language stringrequired

    Язык используемый для ответов

    Example: ru-RU
    X-LP-Client-Identifier stringrequired

    Идентификатор клиента

    Example: 1dcd6f78-82ec-44fe-aae3-3cf20c36f785
    X-LP-Client-Type stringrequired

    Possible values: [Unknown, App, WebApp, Service, Android]

    Тип клиента

    Example: App
    X-LP-Client-Name string

    Имя клиента

    Example: Swagger
    X-LP-Client-OS-Name string

    ОС клиента

    Example: SwaggerDoc
    X-LP-Client-OS-Version string

    Версия ОС клиента

    Example: 1.0
    X-LP-Client-Screen-Resolution string

    Разрешение экрана ОС клиента

    Example: 1280x0900
    X-LP-Client-Model string

    Модель оборудования клиента

    Example: Chrome 75
    X-LP-Organization-Alias string

    Организация по умолчанию

    X-LP-Client-Extensions csv

    Поддерживаемые клиентом расширения моделей

Body

Учетные данные для входа в систему

    full_username stringrequired

    Possible values: >= 2 characters and <= 49 characters

    Логин пользователя вида username@company

    password stringrequired

    Possible values: >= 6 characters and <= 32 characters

    Пароль

    response_type AuthResponseType (string)

    Possible values: [Session, Token]

    Тип ответа удачной аутентификации

Responses​

Success

Schema

    token stringnullable

    Токен доступа пользователя

Loading...