MfaBeginEnrollOptions

Décrit toutes les propriétés et méthodes offertes pour personnaliser l’écran mfa-begin-enroll-options de 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 des 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 d’image de marque et les paramètres.

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

Contient des données sur le prompt actuel 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 tenant, 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

Gère les données non fiables transmises au SDK, comme les saisies de l’utilisateur pendant l’inscription à l’AMF.

user · UserMembers

Détails de l’utilisateur actif, notamment username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

Cette méthode change la langue d’affichage de la page de connexion 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 locale de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsqu’il est défini sur 'session', la langue sélectionnée est enregistrée pour toute la durée de la session.

enroll · Promise<void>

Cette méthode poursuit le processus d’inscription avec 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 qui indique quel facteur inscrire. L’une des valeurs suivantes : “push-notification”, “otp”, “sms”, “phone”, “voice” ou “webauthn-roaming”.

getErrors · Error []

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