auth

Позволяет аутентифицировать пользователей.

Описание

Этот метод выполняет авторизацию пользователя. Он возвращает Promise, который разрешается в объект IAuthEntity.

AuthProvider.auth(

marker, body

);

Схема параметров

Схема

marker(обязательный): string
Текстовый идентификатор провайдера авторизации
пример: "email"

body(обязательный): IAuthPostBody
Объекты содержат информацию для авторизации
пример:

{
  "authData": [
    {
      "marker": "login",
      "value": "example@oneentry.ru"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ]
}

body.authData any[]
Данные авторизации, полученные из формы, прикрепленной к провайдеру авторизации
пример: ""

[
  {
    "marker": "login",
    "value": "example@oneentry.ru"
  },
  {
    "marker": "password",
    "value": "12345"
  }
]

body.authData[index].marker string
Маркер атрибута логина формы регистрации
пример: "example@oneentry.ru"

body.authData[index].value string
Значение атрибута логина формы регистрации
пример: "12345"

Примеры

Минимальный пример

const body = {
"authData": [
{
"marker": "login",
"value": "example@oneentry.ru"
},
{
"marker": "password",
"value":"12345"
}
],
};
const response = await AuthProvider.auth('email', body);

Пример ответа

{
  "userIdentifier": "test@test.ru",
  "authProviderIdentifier": "email",
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6OCwiYXV0aFByb3ZpZGVySWRlbnRpZmllciI6ImVtYWlsIiwidXNlcklkZW50aWZpZXIiOiJ0ZXN0QHRlc3QucnUiLCJ1c2VyQWdlbnQiOiJub2RlIiwiaWF0IjoxNzUzMDkwODAzLCJleHAiOjE3NTMxMjY4MDN9.A7GkUmqKcKDKCcSVV9FITqOD0LebvgurvIUMqzy7E4w",
  "refreshToken": "1753090803738-11c4d812-662e-42c6-a08e-4d882e493bfb"
}

Схема ответа

Схема: IAuthEntity

userIdentifier: string
Уникальный идентификатор пользователя.
пример: "user12345"

authProviderIdentifier: string
Идентификатор провайдера аутентификации.
пример: "email"

accessToken: string
Токен доступа для сессии пользователя.
пример: "abcdef123456"

refreshToken: string
Токен обновления для продления токена доступа.
пример: "ghijkl789012"

---