MfaPushWelcome

Décrit tous les hooks et méthodes disponibles pour personnaliser l’écran mfa-push-welcome de Universal Login.

L’écran mfa-push-welcome présente à l’utilisateur la MFA par notification poussée et l’invite à s’inscrire ou à choisir une autre méthode d’authentification.

​

Import

Chaque écran dispose de son propre ensemble de hooks et de méthodes. Le SDK prend en charge les imports partiels et les imports racine pour chaque écran.

• Un import partiel vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• Un import racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous voulez une version unifiée capable de gérer tous les écrans possibles.

Import Example

// importation racine
import { useMfaPushWelcome } from '@auth0/auth0-acul-react';

// importation partielle
import {
  useMfaPushWelcome,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  enroll,
  pickAuthenticator,
} from "@auth0/auth0-acul-react/mfa-push-welcome";

function MfaPushWelcomeScreen() {
  const { enroll } = useMfaPushWelcome();
  return (
    <button onClick={() => enroll()}>
      Set Up Push Notifications
    </button>
  );
}

​

Hooks de contexte

Hooks propres à l’écran qui fournissent un accès en lecture seule aux données de contexte Auth0 sur l’écran mfa-push-welcome. Importez-les depuis @auth0/auth0-acul-react/mfa-push-welcome.

useBranding · () => BrandingMembers

Ce hook fournit les paramètres d’image de marque, comme le logo, les couleurs et les paramètres de thème affichés sur l’écran mfa-push-welcome.

Example

import { useBranding } from '@auth0/auth0-acul-react/mfa-push-welcome';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

Ce hook fournit des configurations liées à l’application, comme id, name et logoUrl, pour l’écran mfa-push-welcome.

Example

import { useClient } from '@auth0/auth0-acul-react/mfa-push-welcome';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’organisation de l’utilisateur si le flux MFA est limité à une organisation. Il renvoie null lorsqu’aucun contexte d’organisation n’est présent.

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-push-welcome';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>Aucun contexte d’organisation</p>;
  }
}

usePrompt · () => PromptMembers

Ce hook contient des données sur l’invite en cours dans le flux d’authentification.

Example

import { usePrompt } from '@auth0/auth0-acul-react/mfa-push-welcome';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnMfaPushWelcome

Ce hook contient des détails propres à l’écran mfa-push-welcome, y compris sa configuration et son contexte.

Example

import { useScreen } from '@auth0/auth0-acul-react/mfa-push-welcome';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

Ce hook contient des données liées au locataire, comme id et les métadonnées associées.

Example

import { useTenant } from '@auth0/auth0-acul-react/mfa-push-welcome';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

Ce hook fournit des données propres à la transaction pour l’écran mfa-push-welcome, comme l’état actuel du flux MFA.

Example

import { useTransaction } from '@auth0/auth0-acul-react/mfa-push-welcome';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

Ce hook fournit les données non fiables transmises à l’écran, comme des valeurs préremplies à partir des paramètres d’URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/mfa-push-welcome';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

Ce hook fournit des renseignements sur l’utilisateur actif, notamment username, email et les méthodes d’authentification disponibles.

Exemple

import { useUser } from '@auth0/auth0-acul-react/mfa-push-welcome';
function UserProfile() {
  const user = useUser();
}

useMfaPushWelcome · MfaPushWelcomeMembers

Ce hook renvoie toutes les méthodes et le contexte disponibles dans l’écran mfa-push-welcome.

​

Méthodes

enroll · Promise<void>

Cette méthode lance le flux d’inscription aux notifications poussées pour l’utilisateur.

Example

import { useMfaPushWelcome } from '@auth0/auth0-acul-react/mfa-push-welcome';

function EnrollButton() {
  const { enroll } = useMfaPushWelcome();
  return (
    <button onClick={() => enroll()}>
      Configurer les notifications poussées
    </button>
  );
}

pickAuthenticator · Promise<void>

Cette méthode redirige vers l’écran de sélection de l’authentificateur pour permettre à l’utilisateur de choisir une autre méthode MFA.

Example

import { useMfaPushWelcome } from '@auth0/auth0-acul-react/mfa-push-welcome';

function PickAuthenticatorButton() {
  const { pickAuthenticator } = useMfaPushWelcome();
  return (
    <button onClick={() => pickAuthenticator()}>
      Choisir un authentificateur
    </button>
  );
}

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration à plat à partir du contexte d’image de marque.

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant de changer la langue d’affichage de l’écran ACUL actuel.

useCurrentScreen · Hooks

Ce hook récupère le contexte et l’état actuels de l’écran.

useErrors · Hooks

Ce hook permet de consulter et de gérer les erreurs du serveur, côté client et du développeur sur l’écran.