auth

Permite autenticar usuarios.

Descripción

Devuelve una Promesa que se resuelve en un objeto IAuthEntity.

AuthProvider.auth(

marker*, body*, body.authData*, authData.marker*, authData.value*

);

Esquema de parámetros

Esquema

marker(requerido): string
El identificador de texto del proveedor de autorización
ejemplo: "email"

body(requerido): IAuthPostBody
Los objetos contienen información de autenticación
ejemplo:

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

body.authData(requerido): IAuthData[]
Un array de objetos de datos de autenticación, cada uno conteniendo un marcador y su valor correspondiente.
ejemplo:

[
  {
    "marker": "login",
    "value": "user@example.com"
  }
]

authData.marker(requerido): string
El marcador que identifica el campo de autenticación.
ejemplo: "login"

authData.value(requerido): string
El valor del campo de autenticación.
ejemplo: .com"

body.authData any[]
Datos de autorización tomados del formulario adjunto al proveedor de autorización
ejemplo: ""

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

body.authData[index].marker string
Marcador del atributo de inicio de sesión del formulario de registro
ejemplo: "example@oneentry.cloud"

body.authData[index].value string
Valor del atributo de inicio de sesión del formulario de registro
ejemplo: "12345"

Ejemplos

Ejemplo mínimo

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

Ejemplo de respuesta

{
  "userIdentifier": "test@test.ru",
  "authProviderIdentifier": "email",
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpX...",
  "refreshToken": "1776262769878-0ef81b3a-6d47-49d8..."
}

Esquema de respuesta

Esquema: IAuthEntity

userIdentifier: string
El identificador único para el usuario.
ejemplo: "user12345"

authProviderIdentifier: string
El identificador para el proveedor de autenticación.
ejemplo: "email"

accessToken: string
El token de acceso para la sesión del usuario.
ejemplo: "abcdef123456"

refreshToken: string
El token de actualización para renovar el token de acceso.
ejemplo: "ghijkl789012"

---