getAuthProviderByMarker

Obtenir un fournisseur d'authentification par son marqueur.

Description

Renvoie un IAuthProvidersEntity.

.getAuthProviderByMarker(

,

);

Schéma des paramètres

Schéma

marker(obligatoire) : string
Marqueur du fournisseur d'authentification.
exemple : "email"

langCode : string
Code de langue. Par défaut : le langCode passé à defineOneEntry ("en_US" s'il n'y en a pas).
exemple : "en_US"

Exemples

Exemple minimal

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

Exemple avec langCode

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

Exemple de réponse

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

Schéma de réponse

Schéma : IAuthProvidersEntity

id : number
ID du fournisseur d'authentification.
exemple : 194

localizeInfos : ILocalizeInfo
Données localisées du fournisseur d'authentification.
exemple :

{
  "title": "Example title"
}

config : IAuthProvidersEntityConfig
Configuration du fournisseur sous forme de paires clé-valeur.
exemple :

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

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 secondes (malgré le suffixe Mc).
example: "604800"

config.deleteNoneActiveUsersAfterDays : string
Nombre de jours après lesquels les utilisateurs inactifs sont supprimés.
exemple : "30"

config.systemCodeTlsSec : string
Durée de vie du code à usage unique, en secondes.
exemple : "86400"

config.systemCodeLength : string
Longueur du code à usage unique.
exemple : "6"

config.oauthAuthUrl : string | null
URL d'autorisation OAuth.
exemple : null

config.systemCodeOnlyNumbers : string | null
Indique si le code à usage unique n'utilise que des chiffres ; null s'il n'est pas défini.
exemple : null

version : number
Numéro de version du fournisseur d'authentification ; change à chaque mise à jour.
exemple : 1

identifier : string
Marqueur du fournisseur d'authentification.
exemple : "email"

type : string
Type du fournisseur d'authentification, par exemple "email".
exemple : "email"

formIdentifier : string | null
Marqueur du formulaire lié au fournisseur d'authentification, ou null s'il n'y en a pas.
exemple : "reg_form"

userGroupIdentifier : string
Identifiant du groupe d'utilisateurs lié au fournisseur d'authentification.
exemple : "guest"

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

isCheckCode : boolean
Indique si les nouveaux utilisateurs doivent être activés avec un code à usage unique. Permet aussi de se connecter avec un code au lieu d'un mot de passe.
exemple : false

---