MfaBeginEnrollOptions

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

La classe MfaBeginEnrollOptions implémente les fonctionnalités de l’écran mfa-begin-enroll-options. Cet écran gère la sélection et l’inscription aux facteurs MFA.

​

Constructeurs

Créez une instance du gestionnaire de l’écran MFA Begin Enroll Options :

Example

import MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options';
const mfaBeginEnrollOptions = new MfaBeginEnrollOptions();
await mfaBeginEnrollOptions.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.

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

Contient des détails propres à l’écran mfa-begin-enroll-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-begin-enroll-options, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Prend en charge les données non fiables transmises au SDK, comme les entrées utilisateur pendant l’inscription MFA.

user · UserMembers

Contient les détails de l’utilisateur actif, y compris username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

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

Example

import MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options';
const mfaBeginEnrollOptions = new MfaBeginEnrollOptions();
mfaBeginEnrollOptions.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de paramètres régionaux de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsqu’elle est définie à 'session', la langue sélectionnée est conservée pendant toute la durée de la session.

enroll · Promise<void>

Cette méthode poursuit le processus d’inscription pour le facteur sélectionné.

Example

import MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options';

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

Paramètres de la méthode

Afficher Paramètres

options

MfaEnrollOptions.

action · "push-notification" | "otp" | "sms" | "phone" | "voice" | "webauthn-roaming" · requis

L’action indiquant le facteur à inscrire. Une des valeurs suivantes : “push-notification”, “otp”, “sms”, “phone”, “voice” ou “webauthn-roaming”.

getErrors · Error []

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