MfaOtpEnrollmentCode

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

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

​

Constructeurs

Créez une instance du gestionnaire de l’écran MFA OTP Enrollment Code :

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 des configurations liées à l’image de marque, comme le thème de l’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-enrollment-code.

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 · 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 tenant, 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 données saisies par l’utilisateur pendant l’inscription à l’AMF OTP.

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 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 correspondant à la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsqu’elle est définie à '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 à l’AMF 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 récupère le tableau des erreurs de transaction dans le contexte, ou un tableau vide s’il n’y en a aucune.

toggleView · Promise<void>

Cette méthode bascule entre l’affichage du code QR et la 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 d’AMF.

Example

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

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