Pular para o conteúdo principal

getAuthProviders

Obtém todos os objetos dos provedores de autenticação.

Descrição

Este método obtém todos os objetos dos provedores de autorização. Ele retorna uma Promise que resolve para um array de objetos IAuthProvidersEntity.

AuthProvider.getAuthProviders(

langCode, offset, limit

);

Esquema de parâmetros

Esquema

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

offset: number
Parâmetro para paginação. Padrão: 0
exemplo: 0

limit: number
Parâmetro para paginação. Padrão: 30
exemplo: 30

Exemplos

Exemplo mínimo

const response = await AuthProvider.getAuthProviders();

Exemplo com atributos

const response = await AuthProvider.getAuthProviders('en_US', 0, 30);

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"
}

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