MfaPushChallengePush

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

La classe MfaPushChallengePush implémente les fonctionnalités de l’écran mfa-push-challenge-push. Cet écran s’affiche lorsqu’un utilisateur doit confirmer une notification push dans le cadre de l’AMF.

​

Constructeurs

Créez une instance du gestionnaire de l’é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 d’image de marque, comme le thème d’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-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 le prompt actuel dans le flux d’authentification.

screen · ScreenMembersOnMfaPushChallengePush

Contient des détails propres à l’écran mfa-push-challenge-push, 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-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 saisies de l’utilisateur pendant le défi push d’AMF.

user · UserMembers

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 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 locale 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 enregistrée pour toute la durée de la session.

continue · Promise<void>

Cette méthode poursuit le défi 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 l’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 à partir du 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 push d’AMF.

Elle crée une session de polling qui vérifie de façon répétée l’endpoint du défi push d’AMF selon l’intervalle indiqué, jusqu’à ce que le challenge soit approuvé 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 l’instance MfaPushPollingControl retournée pour démarrer, arrêter ou vérifier l’état du processus de polling en tout temps.

Retourne une instance MfaPushPollingControl qui expose :

• startPolling() — Démarre ou reprend le polling.
• stopPolling() — Arrête 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 le défi push d’AMF soit approuvé
const control = mfaPushChallengePush.pollingManager({
  intervalMs: 5000,
  onCompleted: () => mfaPushChallengePush.continue(),
  onError: (error) => console.error('Polling error:', error),
});

// Plus tard, arrêter le polling au besoin
control.stopPolling();

Remarques

• Les réponses HTTP 429 (rate limit) sont gérées à l’interne : le polling attend automatiquement que la limite soit réinitialisée avant de réessayer.
• Vous pouvez appeler startPolling() plusieurs fois en toute sécurité ; cela n’a aucun effet si le processus 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 de polling consécutives. S’il est omis, l’intervalle interne par défaut du SDK est utilisé (habituellement 5000 ms).

onCompleted()? · () => void

Fonction de rappel facultative exécutée une fois que le défi push d’AMF 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 invoquée si une erreur survient pendant le polling. Elle reçoit un objet ULError contenant status (code d’état HTTP) et responseText (corps de la réponse brut).

resendPushNotification · Promise<void>

Cette méthode renvoie 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 AMF.

Example

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

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