MfaPushChallengePush

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

La classe MfaPushChallengePush implémente la fonctionnalité de l’écran mfa-push-challenge-push. Cet écran s’affiche lorsqu’un utilisateur doit confirmer une notification push lors de la MFA.

​

Constructeurs

Créez une instance du gestionnaire d’écran MFA Push Challenge Push :

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.continue();

​

Propriétés

branding · BrandingMembers

Fournit des configurations liées à l’image de marque, comme le thème et les paramètres.

client · ClientMembers

Fournit des configurations liées à l’application, comme id, name et logoUrl, pour l’écran mfa-push-challenge-push.

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

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

untrustedData · UntrustedDataMembersOnMfaPushChallengePush

Gère les données non fiables transmises au SDK, comme les entrées utilisateur pendant le défi MFA push.

user · UserMembers

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 de Universal Login.

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';
const mfaPushChallengePush = new MfaPushChallengePush();
mfaPushChallengePush.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue souhaité (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 poursuit la vérification par notification push.

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.continue();

Paramètres de la méthode

Afficher Paramètres

options

WithRememberOptions.

rememberDevice? · boolean

Indique s’il faut mémoriser cet appareil.

enterCodeManually · Promise<void>

Cette méthode passe à la saisie manuelle du code de vérification.

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.enterCodeManually();

getErrors · Error []

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

pollingManager · MfaPushPollingControl

Cette méthode lance et gère le polling d’un défi MFA push.

Elle crée une session de polling qui vérifie de façon répétée le point de terminaison du défi MFA push à l’intervalle spécifié jusqu’à ce que la demande soit approuvée ou qu’une erreur survienne. Lorsque la condition d’approbation est remplie, la fonction de rappel onCompleted fournie est appelée et le polling s’arrête automatiquement.

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

Retourne une instance de MfaPushPollingControl qui expose :

• startPolling() — Démarre ou reprend le polling.
• stopPolling() — Annule le polling immédiatement.
• isRunning() — Indique si le polling est actuellement actif.

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();

// Démarrer le polling toutes les 5 secondes jusqu’à ce que la demande push soit approuvée
const control = mfaPushChallengePush.pollingManager({
  intervalMs: 5000,
  onCompleted: () => mfaPushChallengePush.continue(),
  onError: (error) => console.error('Polling error:', error),
});

// Plus tard, annuler le polling au besoin
control.stopPolling();

Remarques

• Les réponses HTTP 429 (limitation du débit) sont gérées en interne : le polling attend automatiquement que la limite soit réinitialisée avant de réessayer.
• Il est sûr d’appeler startPolling() plusieurs fois; cela n’a aucun effet si le polling est déjà en cours.

Paramètres de la méthode

Afficher Paramètres

options

MfaPollingOptions.

intervalMs? · number

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

onCompleted()? · () => void

Fonction de rappel facultative exécutée une fois que le défi MFA push a été approuvé avec succès et que le polling est terminé. Elle est appelée exactement une fois, après quoi le polling s’arrête automatiquement.

onError()? · (error) => void

Fonction de rappel facultative appelée si une erreur survient pendant le polling. Reçoit un objet ULError contenant status (code d’état HTTP) et responseText (corps brut de la réponse).

resendPushNotification · Promise<void>

Cette méthode réenvoie la notification push.

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.resendPushNotification();

Paramètres de la méthode

Afficher Paramètres

options

WithRememberOptions.

rememberDevice? · boolean

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

tryAnotherMethod · Promise<void>

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

Example

import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.tryAnotherMethod();