MfaPushWelcome

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran mfa-push-welcome de Universal Login.

La classe MfaPushWelcome implémente les fonctionnalités de l’écran mfa-push-welcome.

​

Constructeurs

Créez une instance du gestionnaire de l’écran Welcome pour MFA Push :

Example

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';

const mfaPushWelcome = new MfaPushWelcome();
await mfaPushWelcome.enroll();

​

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-push-welcome.

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 · ScreenMembersOnMfaPushWelcome

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

untrustedData · UntrustedDataMembers

Traite les données non fiables transmises au SDK, comme les saisies de l’utilisateur pendant l’écran d’accueil MFA push.

user · UserMembers

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 Universal Login.

Example

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';
const mfaPushWelcome = new MfaPushWelcome();
mfaPushWelcome.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue voulu (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsqu’il est défini sur 'session', la langue sélectionnée est conservée pendant toute la session.

enroll · Promise<void>

Cette méthode mène à l’écran d’inscription.

Example

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';

const mfaPushWelcome = new MfaPushWelcome();
await mfaPushWelcome.enroll();

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.

pickAuthenticator · Promise<void>

Cette méthode mène à l’écran de sélection de l’authentificateur.

Example

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';

const mfaPushWelcome = new MfaPushWelcome();
await mfaPushWelcome.pickAuthenticator();