MfaOtpChallenge

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

La classe MfaOtpChallenge implémente la fonctionnalité de l’écran mfa-otp-challenge. Cet écran s’affiche lorsqu’un utilisateur doit saisir un code OTP dans le cadre de la MFA.

​

Constructeurs

Créez une instance du gestionnaire de l’écran de défi OTP MFA :

Example

import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';

const mfaOtpChallenge = new MfaOtpChallenge();
await mfaOtpChallenge.continue({
  code: '123456',
  rememberDevice: true
});

​

Propriétés

branding · BrandingMembers

Fournit des configurations d’image de marque, comme le thème et les paramètres associés.

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaOtpChallenge

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

untrustedData · UntrustedDataMembersOnMfaOtpChallenge

Traite les données non fiables transmises au SDK, comme les entrées de l’utilisateur lors du défi OTP de MFA.

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 MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';
const mfaOtpChallenge = new MfaOtpChallenge();
mfaOtpChallenge.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

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

persist? · "session"

Lorsque cette option est définie à 'session', la langue sélectionnée est conservée pendant toute la session.

continue · Promise<void>

Cette méthode poursuit le défi OTP à l’aide du code fourni.

Example

import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';

const mfaOtpChallenge = new MfaOtpChallenge();
await mfaOtpChallenge.continue({
  code: '123456',
  rememberDevice: true
});

Paramètres de la méthode

Afficher Paramètres

options

ContinueOTPOptions.

code · string · requis

Le code OTP saisi par l’utilisateur.

rememberDevice? · boolean

Indique s’il faut mémoriser le navigateur.

getErrors · Error []

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

tryAnotherMethod · Promise<void>

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

Example

import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';

const mfaOtpChallenge = new MfaOtpChallenge();
await mfaOtpChallenge.tryAnotherMethod();