MfaOtpEnrollmentCode

Décrit toutes les propriétés et méthodes offertes pour personnaliser l’écran mfa-otp-enrollment-code dans Universal Login.

La classe MfaOtpEnrollmentCode implémente la fonctionnalité de l’écran mfa-otp-enrollment-code. Cet écran s’affiche lorsque l’utilisateur doit saisir le code OTP reçu lors de l’inscription à la MFA.

​

Constructeurs

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

Example

import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';

const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
await mfaOtpEnrollmentCode.continue({
  code: '123456',
});

​

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-otp-enrollment-code.

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

Contient des détails propres à l’écran mfa-otp-enrollment-code, 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-otp-enrollment-code, 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 pendant l’inscription à la MFA par OTP.

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 MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';
const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
mfaOtpEnrollmentCode.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"

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

continue · Promise<void>

Cette méthode poursuit le processus d’inscription à la MFA par OTP en soumettant le code OTP.

Example

import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';

const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
await mfaOtpEnrollmentCode.continue({
  code: '123456',
});

Paramètres de la méthode

Afficher Paramètres

options

MfaOtpContinueOptions.

code · string · requis

Le code OTP saisi par l’utilisateur.

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.

toggleView · Promise<void>

Cette méthode bascule entre les vues par code QR et saisie manuelle.

Example

import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';

const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
await mfaOtpEnrollmentCode.toggleView();

tryAnotherMethod · Promise<void>

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

Example

import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';

const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
await mfaOtpEnrollmentCode.tryAnotherMethod();