auth

Permite autenticar usuários.

Descrição

Retorna uma Promise que resolve para um objeto IAuthEntity.

AuthProvider.auth(

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

);

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(obrigatório): IAuthData[]
Um array de objetos de dados de autenticação, cada um contendo um marcador e seu valor correspondente.
exemplo:

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

authData.marker(obrigatório): string
O marcador que identifica o campo de autenticação.
exemplo: "login"

authData.value(obrigatório): string
O valor do campo de autenticação.
exemplo: .com"

body.authData any[]
Dados de autorização retirados 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": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpX...",
  "refreshToken": "1776262769878-0ef81b3a-6d47-49d8..."
}

Esquema de resposta

Esquema: IAuthEntity

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

authProviderIdentifier: string
O identificador para o 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"

---