Saltar al contenido principal

auth

Permite autenticar a los usuarios.

Descripción

Este método realiza la autorización del usuario. Devuelve una Promesa que se resuelve en un objeto IAuthEntity.

AuthProvider.auth(

marker, body

);

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 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",
},
{
"marker": "password",
"value":"12345"
}
],
};

const response = await AuthProvider.auth('email', body);

Ejemplo de respuesta

{
"userIdentifier": "test@test.ru",
"authProviderIdentifier": "email",
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6OCwiYXV0aFByb3ZpZGVySWRlbnRpZmllciI6ImVtYWlsIiwidXNlcklkZW50aWZpZXIiOiJ0ZXN0QHRlc3QucnUiLCJpYXQiOjE3NTkyNjQzNjEsImV4cCI6MTc1OTMwMDM2MX0.rEa9MeA540H7NYUngnlz6zPUM9G-VqoFbFkGrqy8buw",
"refreshToken": "1759264361355-493c46b6-0a99-4871-9808-9a5524eef515"
}

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"