getAuthProviderByMarker

Obter um provedor de autenticação pelo marcador.

Descrição

Resolve para um IAuthProvidersEntity.

.getAuthProviderByMarker(

,

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
Marcador do provedor de autenticação.
exemplo: "email"

langCode: string
Código do idioma. Padrão: o langCode passado para defineOneEntry ("en_US" se nenhum for passado).
exemplo: "en_US"

Exemplos

Exemplo mínimo

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

Exemplo com langCode

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

Exemplo de resposta

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

Esquema de resposta

Esquema: IAuthProvidersEntity

id: number
ID do provedor de autenticação.
exemplo: 194

localizeInfos: ILocalizeInfo
Dados localizados do provedor de autenticação.
exemplo:

{
  "title": "Example title"
}

config: IAuthProvidersEntityConfig
Configuração do provedor como pares chave-valor.
exemplo:

{
  "accessTokenTtlSec": "36000",
  "refreshTokenTtlMc": "604800",
  "deleteNoneActiveUsersAfterDays": "2",
  "systemCodeTlsSec": "120",
  "systemCodeLength": "6",
  "systemCodeOnlyNumbers": null,
  "oauthAuthUrl": null
}

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 segundos (apesar do sufixo Mc).
example: "604800"

config.deleteNoneActiveUsersAfterDays: string
Número de dias após os quais usuários inativos são excluídos.
exemplo: "30"

config.systemCodeTlsSec: string
Tempo de vida do código de uso único, em segundos.
exemplo: "86400"

config.systemCodeLength: string
Comprimento do código de uso único.
exemplo: "6"

config.oauthAuthUrl: string | null
URL de autorização OAuth.
exemplo: null

config.systemCodeOnlyNumbers: string | null
Se o código de uso único usa apenas dígitos; null quando não definido.
exemplo: null

version: number
Número da versão do provedor de autenticação; muda a cada atualização.
exemplo: 1

identifier: string
Marcador do provedor de autenticação.
exemplo: "email"

type: string
Tipo do provedor de autenticação, por exemplo "email".
exemplo: "email"

formIdentifier: string | null
Marcador do formulário vinculado ao provedor de autenticação, ou null se não houver.
exemplo: "reg_form"

userGroupIdentifier: string
Identificador do grupo de usuários vinculado ao provedor de autenticação.
exemplo: "guest"

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

isCheckCode: boolean
Se novos usuários precisam ser ativados com um código de uso único. Também permite fazer login com um código em vez de senha.
exemplo: false

---