AuthRepository
Документация для класса AuthRepository.
Методы
login
Описание
Метод для выполнения входа в систему. Отправляет запрос с данными для логина и возвращает токен, если вход успешен.
HTTP метод: POST
URL: /api/v1/auth/login
Параметры:
| Имя | Тип | Описание |
|---|---|---|
params | ILoginPayload |
Возвращает: Promise<ILoginResponse>
requestPasswordReset
Описание
Метод для запроса сброса пароля. Отправляет запрос с email и возвращает сообщения о статусе запроса.
HTTP метод: POST
URL: /api/v1/auth/password/forgot
Параметры:
| Имя | Тип | Описание |
|---|---|---|
payload | IRequestPasswordResetPayload |
Возвращает: Promise<string[]>
signUp
Описание
Метод для установки нового пароля. Отправляет запрос с данными для сброса пароля, включая email, токен и новый пароль.
HTTP метод: POST
URL: /api/v1/auth/register/default
Параметры:
| Имя | Тип | Описание |
|---|---|---|
payload | ISignUpPayload |
Возвращает: Promise<void>
setNewPassword
Описание
Метод для регистрации нового пользователя. Отправляет запрос с параметрами для регистрации и не возвращает данных.
HTTP метод: POST
URL: /api/v1/auth/password/reset
Параметры:
| Имя | Тип | Описание |
|---|---|---|
payload | ISetNewPasswordPayload |
Возвращает: Promise<void>
logout
Описание
Выполняет выход пользователя из системы. Отправляет GET-запрос на эндпоинт logout.
HTTP метод: GET
URL: /api/v1/auth/logout
Параметры: Нет
Возвращает: Promise<void>
registration
Описание
Метод регистрации пользователя
HTTP метод: POST
URL: /api/v1/auth/register/ecp
Параметры:
| Имя | Тип | Описание |
|---|---|---|
payload | IRegistrationPayload |
Возвращает: Promise<void>
loginBySSO
Описание
Авторизация через SSO
HTTP метод: POST
URL: /api/v1/auth/login/sso
Параметры:
| Имя | Тип | Описание |
|---|---|---|
payload | ILoginBySSOPayload |
Возвращает: Promise<ILoginBySSOResponse>
setVerify
Описание
Верифицировать пользователя
HTTP метод: POST
URL: /api/v1/auth/verify/check
Параметры:
| Имя | Тип | Описание |
|---|---|---|
payload | ISetVerifyPayload |
Возвращает: Promise<void>
sendNewVerifyToken
Описание
Заново сгенерировать токен верификации. Включая, повторную отправку письма
HTTP метод: POST
URL: /api/v1/auth/verify/send
Параметры: Нет
Возвращает: Promise<void>
setPassword
Описание
Установка пароля, когда его в принципе не существует Активен для кейса, после верификации пользователя
HTTP метод: POST
URL: /api/v1/auth/verify
Параметры:
| Имя | Тип | Описание |
|---|---|---|
payload | ISetPasswordPayload |
Возвращает: Promise<void>
Определения типов
Определения интерфейсов, перечислений и псевдонимов типов, используемых в методах этого репозитория.
IAuthRepository
Интерфейс не содержит собственных свойств и не наследует другие локальные интерфейсы.
ILoginBySSOPayload
| Свойство | Тип | Описание |
|---|---|---|
code | string |
ILoginBySSOResponse
| Свойство | Тип | Описание |
|---|---|---|
token | string |
ILoginPayload
| Свойство | Тип | Описание |
|---|---|---|
email | string | |
password | string |
ILoginResponse
| Свойство | Тип | Описание |
|---|---|---|
token | string |
IRegistrationPayload
| Свойство | Тип | Описание |
|---|---|---|
uuid | string | |
email | string |
IRequestPasswordResetPayload
| Свойство | Тип | Описание |
|---|---|---|
email | string |
ISetNewPasswordPayload
| Свойство | Тип | Описание |
|---|---|---|
email | string | |
token | string | |
password | string | |
password_confirmation | string |
ISetPasswordPayload
| Свойство | Тип | Описание |
|---|---|---|
password | string |
ISetVerifyPayload
| Свойство | Тип | Описание |
|---|---|---|
token | string |
ISignUpPayload
| Свойство | Тип | Описание |
|---|---|---|
uuid | string | |
name | string | |
identifier | string | |
lastname | string | |
phone (опц.) | string | |
surname (опц.) | string | |
password | string | |
password_confirmation | string | |
email | string |