MfaOtpEnrollmentQr

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

La classe MfaOtpEnrollmentQr implémente la fonctionnalité de l’écran mfa-otp-enrollment-qr. Cet écran affiche un code QR que l’utilisateur peut numériser avec son application d’authentification lors de l’inscription à MFA.

​

Constructeurs

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

Example

import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.toggleView();

​

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-qr.

organization · OrganizationMembers

Fournit des informations 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 · ScreenMembersOnMfaOtpEnrollmentQr

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

untrustedData · UntrustedDataMembers

Traite les données non fiables transmises au SDK, comme les saisies de l’utilisateur pendant l’inscription à MFA OTP.

user · UserMembers

Contient les détails de l’utilisateur actif, notamment username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

Cette méthode modifie la langue d’affichage de la page Universal Login.

Example

import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';
const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
mfaOtpEnrollmentQr.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code 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 session.

continue · Promise<void>

Cette méthode soumet le code OTP pour poursuivre le processus d’inscription.

Example

import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.continue({ code: '123456' });

Paramètres de la méthode

Afficher Paramètres

options

MfaOtpEnrollmentQrContinueOptions.

code · string · requis

Le code OTP saisi par 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.

toggleView · Promise<void>

Cette méthode permet de basculer entre l’affichage du code QR et la saisie manuelle.

Example

import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.toggleView();

tryAnotherMethod · Promise<void>

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

Example

import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.tryAnotherMethod();