Pular para o conteúdo principal

getAuthProviderByMarker

Obtém um objeto de provedor de autenticação por marcador. Retorna uma Promise que resolve para um objeto IAuthProvidersEntity.

Descrição

AuthProvider.getAuthProviderByMarker(

marker*, langCode

);

Esquema de parâmetros

Esquema

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

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

Exemplos

Exemplo mínimo

const response = await AuthProvider.getAuthProviderByMarker('email');

Exemplo com atributos

const response = await AuthProvider.getAuthProviderByMarker('email', 'en_US');

Exemplo de resposta

{
"id": 1,
"localizeInfos": {
"title": "email"
},
"config": {
"accessTokenTtlSec": "36000",
"refreshTokenTtlMc": "604800",
"tokenSecretKey": "my-secret",
"deleteNoneActiveUsersAfterDays": "2",
"systemCodeTlsSec": "120",
"systemCodeLength": "6"
},
"version": 0,
"identifier": "email",
"type": "email",
"formIdentifier": "reg",
"userGroupIdentifier": "guest",
"isActive": true,
"isCheckCode": false
}

Esquema de resposta

Esquema: IAuthProvidersEntity

id: number
O identificador único da entidade do provedor de autenticação.
exemplo: 194

localizeInfos: ILocalizeInfo
Informações localizadas para o provedor de autenticação.
exemplo:

{
"key": "value"
}

config: IAuthProvidersEntityConfig
Configurações de configuração para o provedor de autenticação, armazenadas como um objeto de pares chave-valor.
exemplo:

{
"key": "value"
}

config.accessTokenTtlSec: string
Tempo de vida do token de acesso em segundos.
exemplo: "3600"

config.refreshTokenTtlMc: string
Tempo de vida do token de atualização em milissegundos.
exemplo: "86400000"

config.tokenSecretKey: string
Chave secreta do token.
exemplo: "secret_key"

config.deleteNoneActiveUsersAfterDays: string
Excluir usuários não ativos após dias.
exemplo: "30"

config.systemCodeTlsSec: string
Tempo de vida do código do sistema em segundos.
exemplo: "86400"

config.systemCodeLength: string
Comprimento do código do sistema.
exemplo: "6"

version: number
O número da versão da entidade do provedor de autenticação.
exemplo: 1

identifier: string
Uma string única que identifica o provedor de autenticação.
exemplo: "email"

type: string
O tipo do provedor de autenticação (por exemplo, 'email', 'google', etc.).
exemplo: "email"

formIdentifier: string | null
O identificador para o formulário associado ao provedor de autenticação, ou null se não aplicável.
exemplo: "reg_form"

userGroupIdentifier: string
O identificador para o grupo de usuários associado ao provedor de autenticação.
exemplo: "guest"

isActive: boolean
Indica se o provedor de autenticação está ativo.
exemplo: true

isCheckCode: boolean
Indica se o provedor de autenticação requer verificação de código.
exemplo: false