MfaLoginOptions

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran mfa-login-options d’Universal Login.

La classe MfaLoginOptions implémente les fonctionnalités de l’écran mfa-login-options. Cet écran permet aux utilisateurs de sélectionner le facteur MFA qu’ils souhaitent utiliser pour se connecter.

​

Constructeurs

Créez une instance du gestionnaire de l’écran des options de connexion MFA :

Example

import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';

const mfaLoginOptions = new MfaLoginOptions();
await mfaLoginOptions.enroll({
  action: 'push-notification'
});

​

Propriétés

branding · BrandingMembers

Fournit des configurations liées à l’image de marque, comme le thème et les paramètres d’image de marque.

client · ClientMembers

Fournit des configurations liées à l’application, comme id, name et logoUrl, pour l’écran mfa-login-options.

organization · OrganizationMembers

Fournit de l’information sur l’organisation de l’utilisateur, comme id et name.

prompt · PromptMembers

Contient des données sur l’invite actuelle dans le flux d’authentification.

screen · ScreenMembersOnMfaLoginOptions

Contient des détails propres à l’écran mfa-login-options, y compris sa configuration et son contexte.

tenant · TenantMembers

Contient des données liées au locataire, comme id et les métadonnées associées.

transaction · TransactionMembers

Fournit des données propres à la transaction pour l’écran mfa-login-options, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Contient les données non fiables transmises au SDK, comme les entrées de l’utilisateur lors de la sélection d’une option de connexion MFA.

user · UserMembers

Contient des détails sur l’utilisateur actif, notamment username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

Cette méthode modifie la langue d’affichage de la page Universal Login.

Example

import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';
const mfaLoginOptions = new MfaLoginOptions();
mfaLoginOptions.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue correspondant à la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsque cette valeur est définie à 'session', la langue sélectionnée est conservée pendant toute la session.

enroll · Promise<void>

Cette méthode poursuit le processus de connexion avec le facteur MFA sélectionné.

Example

import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';

const mfaLoginOptions = new MfaLoginOptions();
await mfaLoginOptions.enroll({
  action: 'push-notification'
});

Paramètres de la méthode

Afficher Paramètres

options

LoginEnrollOptions.

action · "push-notification" | "otp" | "sms" | "phone" | "voice" | "email" | "recovery-code" | "webauthn-roaming" | "webauthn-platform" | "duo" · requis

L’action qui indique quel facteur inscrire. Une des valeurs suivantes : “push-notification”, “otp”, “sms”, “phone”, “voice”, “email”, “recovery-code”, “webauthn-roaming”, “webauthn-platform” ou “duo”.

getErrors · Error []

Cette méthode récupère le tableau des erreurs de transaction dans le contexte, ou un tableau vide s’il n’y en a pas.

returnToPrevious · Promise<void>

Cette méthode revient à l’écran précédent.

Example

import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options';

const mfaLoginOptions = new MfaLoginOptions();
await mfaLoginOptions.returnToPrevious();