MfaSmsEnrollment

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran mfa-sms-enrollment du Universal Login.

La classe MfaSmsEnrollment implémente la fonctionnalité de l’écran mfa-sms-enrollment. Cet écran s’affiche lorsque l’utilisateur doit inscrire un numéro de téléphone à la MFA par SMS.

​

Constructeurs

Créez une instance du gestionnaire de l’écran d’inscription à la MFA par SMS :

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.continueEnrollment({ phone: '1234567890' });

​

Propriétés

branding · BrandingMembers

Fournit la configuration liée à l’image de marque, comme le thème et les paramètres.

client · ClientMembers

Fournit la configuration liée à l’application, comme id, name et logoUrl, pour l’écran mfa-sms-enrollment.

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

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

untrustedData · UntrustedDataMembers

Traite les données non fiables transmises au SDK, comme la saisie de l’utilisateur pendant l’inscription au MFA par SMS.

user · UserMembers

Détails sur 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 MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
mfaSmsEnrollment.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

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

persist? · "session"

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

continueEnrollment · Promise<void>

Cette méthode poursuit le processus d’inscription par SMS avec le numéro de téléphone fourni.

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.continueEnrollment({ phone: '1234567890' });

Paramètres de la méthode

Afficher Paramètres

options

MfaSmsEnrollmentOptions.

captcha? · string

Le code CAPTCHA ou la réponse du fournisseur CAPTCHA. Obligatoire si la détection des robots est activée dans votre locataire Auth0.

phone? · string

Le numéro de téléphone de l’utilisateur.

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.

pickCountryCode · Promise<void>

Cette méthode redirige vers l’écran où l’utilisateur peut sélectionner l’indicatif du pays pour son numéro de téléphone.

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.pickCountryCode();

tryAnotherMethod · Promise<void>

Cette méthode permet à l’utilisateur d’essayer une autre méthode MFA.

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.tryAnotherMethod();