auth

Permite autenticar usuários.

Descrição

Este método realiza a autorização do usuário. Ele retorna uma Promise que resolve para um objeto IAuthEntity.

AuthProvider.auth(

marker, body

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
O identificador de texto do provedor de autorização
exemplo: "email"

body(obrigatório): IAuthPostBody
Objetos que contêm informações de autenticação
exemplo:

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

body.authData any[]
Dados de autorização obtidos do formulário anexado ao provedor de autorização
exemplo: ""

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

body.authData[index].marker string
Marcador do atributo de login do formulário de registro
exemplo: "example@oneentry.cloud"

body.authData[index].value string
Valor do atributo de login do formulário de registro
exemplo: "12345"

Exemplos

Exemplo mínimo

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

Exemplo de resposta

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

Esquema de resposta

Esquema: IAuthEntity

userIdentifier: string
O identificador único do usuário.
exemplo: "user12345"

authProviderIdentifier: string
O identificador do provedor de autenticação.
exemplo: "email"

accessToken: string
O token de acesso para a sessão do usuário.
exemplo: "abcdef123456"

refreshToken: string
O token de atualização para renovar o token de acesso.
exemplo: "ghijkl789012"

---