MfaPushEnrollmentQr

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

La classe MfaPushEnrollmentQr implémente la fonctionnalité de l’écran mfa-push-enrollment-qr.

​

Constructeurs

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

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.pickAuthenticator();

​

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

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

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

Contient des 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 MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';
const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
mfaPushEnrollmentQr.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de paramètres régionaux de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Si la valeur 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 lance l’inscription par notification push.

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.continue();

Paramètres de la méthode

Afficher Paramètres

options

MfaPushEnrollmentQrWithRememberOptions.

rememberDevice? · boolean

Indique s’il faut mémoriser l’appareil.

getErrors · Error []

Cette méthode récupère le tableau des erreurs de la transaction depuis le contexte, ou un tableau vide s’il n’y en a aucune.

pickAuthenticator · Promise<void>

Cette méthode accède à l’écran de sélection du facteur d’authentification.

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.pickAuthenticator();

pollingManager · MfaPushPollingControl

Cette méthode lance et gère l’interrogation pour une inscription MFA par notification push.

Elle crée une session d’interrogation qui vérifie à intervalles réguliers le point de terminaison d’inscription MFA par notification push jusqu’à ce que l’inscription soit approuvée ou qu’une erreur survienne. Lorsque la condition d’approbation est remplie, le rappel onCompleted fourni est appelé, puis l’interrogation s’arrête automatiquement.

Utilisez l’instance MfaPushPollingControl renvoyée pour démarrer, arrêter ou vérifier l’état du processus d’interrogation à tout moment.

Retourne une instance de MfaPushPollingControl qui expose :

• startPolling() — Démarre ou reprend l’interrogation.
• stopPolling() — Annule l’interrogation immédiatement.
• isRunning() — Indique si l’interrogation est en cours.

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();

// Démarrer l’interrogation toutes les 5 secondes jusqu’à l’approbation de l’inscription push
const control = mfaPushEnrollmentQr.pollingManager({
  intervalMs: 5000,
  onCompleted: () => mfaPushEnrollmentQr.continue(),
  onError: (error) => console.error('Erreur d’interrogation :', error),
});

// Plus tard, annuler l’interrogation au besoin
control.stopPolling();

Remarques

• Les réponses HTTP 429 (limite de débit) sont gérées en interne : l’interrogation attend automatiquement la réinitialisation de la limite avant de réessayer.
• Vous pouvez appeler startPolling() plusieurs fois sans risque; cela n’a aucun effet si l’interrogation est déjà en cours.

Paramètres de la méthode

Afficher Paramètres

options

MfaPollingOptions.

intervalMs? · number

Intervalle facultatif, en millisecondes, entre deux requêtes d’interrogation consécutives. S’il est omis, l’intervalle interne par défaut du SDK est utilisé (généralement 5000 ms).

onCompleted()? · () => void

Rappel facultatif exécuté une fois l’inscription MFA par notification push approuvée avec succès et l’interrogation terminée. Il est appelé une seule fois, après quoi l’interrogation s’arrête automatiquement.

onError()? · (error) => void

Rappel facultatif appelé si une erreur survient pendant l’interrogation. Reçoit un objet ULError contenant status (code d’état HTTP) et responseText (corps brut de la réponse).