MfaPhoneChallenge

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

La classe MfaPhoneChallenge implémente les fonctionnalités de l’écran mfa-phone-challenge. Cet écran s’affiche lorsque l’utilisateur doit recevoir un code pour vérifier son identité.

​

Constructeurs

Créez une instance du gestionnaire de l’écran MFA Phone Challenge :

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.continue({ type: 'sms' });

​

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-phone-challenge.

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaPhoneChallenge

Contient des détails propres à l’écran mfa-phone-challenge, notamment 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-phone-challenge, 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 lors de la vérification téléphonique AMF.

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 MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
mfaPhoneChallenge.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

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

persist? · "session"

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

continue · Promise<void>

Cette méthode envoie le choix de l’utilisateur de recevoir le code d’AMF par SMS ou par appel vocal.

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.continue({ type: 'sms' });

Paramètres de la méthode

Afficher Paramètres

options

MfaPhoneChallengeContinueOptions.

type · "sms" | "voice" · requis

Le mode d’envoi du code d’AMF.

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.

pickPhone · Promise<void>

Cette méthode lance le processus permettant à l’utilisateur de choisir un autre numéro de téléphone.

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.pickPhone();

tryAnotherMethod · Promise<void>

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

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.tryAnotherMethod();