MfaPushWelcome

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

L’écran mfa-push-welcome présente à l’utilisateur l’AMF par notification push et l’invite à enregistrer un authentificateur ou à en choisir un autre.

​

Importation

Chaque écran a son propre ensemble de hooks et de méthodes. Le SDK prend en charge l’importation partielle et l’importation depuis la racine pour chaque écran.

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation depuis la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez une compilation unifiée pour prendre en charge 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 à portée d’écran offrant 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 des configurations d’image de marque, comme le logo, les couleurs et les paramètres du 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 au client, 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’Organization de l’utilisateur si le flux AMF est associé à une Organization. Renvoie null lorsqu’aucun contexte d’Organization n’est présent.

Example

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

usePrompt · () => PromptMembers

Ce hook contient des données sur le prompt actuel 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 tenant, comme id et les metadata 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 AMF.

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook gère les données non fiables transmises à l’écran, comme les valeurs préremplies provenant 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.

Example

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 tout le contexte disponibles à l’écran mfa-push-welcome.

​

Méthodes

enroll · Promise<void>

Cette méthode lance l’enrôlement des notifications push 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 push
    </button>
  );
}

pickAuthenticator · Promise<void>

Cette méthode mène à l’écran de sélection de l’authentificateur afin que l’utilisateur puisse choisir une autre méthode d’AMF.

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 à partir du contexte d’image de marque, avec une configuration aplatie.

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

Ce hook lit et gère les erreurs côté serveur, côté client et côté développeur à l’écran.