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 les fonctionnalités de l’écran mfa-otp-challenge. Cet écran s’affiche lorsqu’un utilisateur doit saisir un code OTP pendant l’authentification MFA.

​

Constructeurs

Créer une instance du gestionnaire d’écran MFA OTP Challenge :

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 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-otp-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 actuel 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 tenant, 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

Contient les données non fiables transmises au SDK, comme la saisie utilisateur durant le défi OTP d’AMF.

user · UserMembers

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

​

Méthodes

changeLanguage · Promise<void>

Cette méthode change 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 langue pour la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsque la valeur est définie sur '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 si le navigateur doit être mémorisé.

getErrors · Error []

Cette méthode récupère le tableau des erreurs de transaction dans le 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 d’AMF.

Example

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

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