Skip to content

AuthRepository

Документация для класса AuthRepository.

Методы

login

Описание

Метод для выполнения входа в систему. Отправляет запрос с данными для логина и возвращает токен, если вход успешен.

HTTP метод: POST

URL: /api/v1/auth/login

Параметры:

ИмяТипОписание
paramsILoginPayload

Возвращает: Promise<ILoginResponse>


requestPasswordReset

Описание

Метод для запроса сброса пароля. Отправляет запрос с email и возвращает сообщения о статусе запроса.

HTTP метод: POST

URL: /api/v1/auth/password/forgot

Параметры:

ИмяТипОписание
payloadIRequestPasswordResetPayload

Возвращает: Promise<string[]>


signUp

Описание

Метод для установки нового пароля. Отправляет запрос с данными для сброса пароля, включая email, токен и новый пароль.

HTTP метод: POST

URL: /api/v1/auth/register/default

Параметры:

ИмяТипОписание
payloadISignUpPayload

Возвращает: Promise<void>


setNewPassword

Описание

Метод для регистрации нового пользователя. Отправляет запрос с параметрами для регистрации и не возвращает данных.

HTTP метод: POST

URL: /api/v1/auth/password/reset

Параметры:

ИмяТипОписание
payloadISetNewPasswordPayload

Возвращает: Promise<void>


logout

Описание

Выполняет выход пользователя из системы. Отправляет GET-запрос на эндпоинт logout.

HTTP метод: GET

URL: /api/v1/auth/logout

Параметры: Нет

Возвращает: Promise<void>


registration

Описание

Метод регистрации пользователя

HTTP метод: POST

URL: /api/v1/auth/register/ecp

Параметры:

ИмяТипОписание
payloadIRegistrationPayload

Возвращает: Promise<void>


loginBySSO

Описание

Авторизация через SSO

HTTP метод: POST

URL: /api/v1/auth/login/sso

Параметры:

ИмяТипОписание
payloadILoginBySSOPayload

Возвращает: Promise<ILoginBySSOResponse>


setVerify

Описание

Верифицировать пользователя

HTTP метод: POST

URL: /api/v1/auth/verify/check

Параметры:

ИмяТипОписание
payloadISetVerifyPayload

Возвращает: Promise<void>


sendNewVerifyToken

Описание

Заново сгенерировать токен верификации. Включая, повторную отправку письма

HTTP метод: POST

URL: /api/v1/auth/verify/send

Параметры: Нет

Возвращает: Promise<void>


setPassword

Описание

Установка пароля, когда его в принципе не существует Активен для кейса, после верификации пользователя

HTTP метод: POST

URL: /api/v1/auth/verify

Параметры:

ИмяТипОписание
payloadISetPasswordPayload

Возвращает: Promise<void>

Определения типов

Определения интерфейсов, перечислений и псевдонимов типов, используемых в методах этого репозитория.

IAuthRepository

Интерфейс не содержит собственных свойств и не наследует другие локальные интерфейсы.


ILoginBySSOPayload

СвойствоТипОписание
codestring

ILoginBySSOResponse

СвойствоТипОписание
tokenstring

ILoginPayload

СвойствоТипОписание
emailstring
passwordstring

ILoginResponse

СвойствоТипОписание
tokenstring

IRegistrationPayload

СвойствоТипОписание
uuidstring
emailstring

IRequestPasswordResetPayload

СвойствоТипОписание
emailstring

ISetNewPasswordPayload

СвойствоТипОписание
emailstring
tokenstring
passwordstring
password_confirmationstring

ISetPasswordPayload

СвойствоТипОписание
passwordstring

ISetVerifyPayload

СвойствоТипОписание
tokenstring

ISignUpPayload

СвойствоТипОписание
uuidstring
namestring
identifierstring
lastnamestring
phone (опц.)string
surname (опц.)string
passwordstring
password_confirmationstring
emailstring