Aller au contenu principal

getAuthProviders

Obtenez tous les objets des fournisseurs d'authentification.

Description

Cette méthode récupère tous les objets des fournisseurs d'autorisation. Elle renvoie une promesse qui se résout en un tableau d'objets IAuthProvidersEntity.

AuthProvider.getAuthProviders(

langCode, offset, limit

);

Schéma des paramètres

Schéma

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

offset: number
Paramètre pour la pagination. Par défaut : 0
exemple : 0

limit: number
Paramètre pour la pagination. Par défaut : 30
exemple : 30

Exemples

Exemple minimal

const response = await AuthProvider.getAuthProviders();

Exemple avec des attributs

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

Exemple de réponse

[
{
"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
}
]

Schéma de réponse

Schéma : IAuthProvidersEntity[]

id: number
L'identifiant unique de l'entité fournisseur d'authentification.
exemple : 194

localizeInfos: ILocalizeInfo
Informations localisées pour le fournisseur d'authentification.
exemple :

{
"key": "value"
}

config: IAuthProvidersEntityConfig
Paramètres de configuration pour le fournisseur d'authentification, stockés sous forme d'objet clé-valeur.
exemple :

{
"key": "value"
}

config.accessTokenTtlSec: string
Durée de vie du jeton d'accès en secondes.
exemple : "3600"

config.refreshTokenTtlMc: string
Durée de vie du jeton de rafraîchissement en millisecondes.
exemple : "86400000"

config.tokenSecretKey: string
Clé secrète du jeton.
exemple : "secret_key"

config.deleteNoneActiveUsersAfterDays: string
Supprimer les utilisateurs inactifs après un certain nombre de jours.
exemple : "30"

config.systemCodeTlsSec: string
Durée de vie du code système en secondes.
exemple : "86400"

config.systemCodeLength: string
Longueur du code système.
exemple : "6"

version: number
Le numéro de version de l'entité fournisseur d'authentification.
exemple : 1

identifier: string
Une chaîne unique qui identifie le fournisseur d'authentification.
exemple : "email"

type: string
Le type du fournisseur d'authentification (par exemple, 'email', 'google', etc.).
exemple : "email"

formIdentifier: string | null
L'identifiant du formulaire associé au fournisseur d'authentification, ou null si non applicable.
exemple : "reg_form"

userGroupIdentifier: string
L'identifiant du groupe d'utilisateurs associé au fournisseur d'authentification.
exemple : "guest"

isActive: boolean
Indique si le fournisseur d'authentification est actif.
exemple : true

isCheckCode: boolean
Indique si le fournisseur d'authentification nécessite une vérification de code.
exemple : false