MfaPushEnrollmentQr

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran mfa-push-enrollment-qr d’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 de code QR d’inscription à MFA Push :

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

client · ClientMembers

Fournit des configurations liées au client, 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 le prompt actuel dans le flux d’authentification.

screen · ScreenMembersOnMfaPushEnrollmentQr

Contient des 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 tenant, 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

Gère les données non fiables transmises au SDK, comme les données saisies par l’utilisateur lors de l’inscription à l’AMF push.

user · UserMembers

Contient les 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 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 locale de 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 l’inscription à la 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 transaction à partir du contexte, ou un tableau vide s’il n’y en a aucune.

pickAuthenticator · Promise<void>

Cette méthode mène à l’écran de sélection de l’authentificateur.

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 à l’AMF push.

Elle crée une session d’interrogation qui vérifie de façon répétée le point de terminaison de l’inscription à l’AMF push à l’intervalle indiqué, jusqu’à ce que l’inscription soit approuvée ou qu’une erreur survienne. Lorsque la condition d’approbation est remplie, le callback onCompleted fourni est appelé et l’interrogation s’arrête automatiquement.

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

Retourne une instance MfaPushPollingControl qui expose :

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

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’à ce que l’inscription push soit approuvée
const control = mfaPushEnrollmentQr.pollingManager({
  intervalMs: 5000,
  onCompleted: () => mfaPushEnrollmentQr.continue(),
  onError: (error) => console.error('Polling error:', 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 que la limite de débit soit réinitialisée avant de réessayer.
• Vous pouvez appeler startPolling() plusieurs fois en toute sécurité ; 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 des requêtes d’interrogation consécutives. S’il est omis, l’intervalle interne par défaut du SDK est utilisé (habituellement 5000 ms).

onCompleted()? · () => void

Callback facultatif exécuté une fois que l’inscription à l’AMF push a été approuvée avec succès et que l’interrogation est terminée. Il est appelé exactement une fois, après quoi l’interrogation s’arrête automatiquement.

onError()? · (error) => void

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