MfaPhoneChallenge

Décrit tous les hooks et toutes les méthodes disponibles pour personnaliser l’écran mfa-phone-challenge d’Universal Login.

L’écran mfa-phone-challenge invite l’utilisateur à vérifier son identité en saisissant un code envoyé à son téléphone par SMS ou par appel vocal.

​

Import

Chaque écran possède son propre ensemble de hooks et de méthodes. Le SDK prend en charge l’import partiel et l’import à la racine pour chaque écran.

• L’import partiel vous permet d’inclure uniquement le code nécessaire à votre cas d’usage.
• L’import à la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez qu’une build unifiée prenne en charge tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useMfaPhoneChallenge,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  continueMethod,
  pickPhone,
  tryAnotherMethod,
} from "@auth0/auth0-acul-react/mfa-phone-challenge";

function MfaPhoneChallengeScreen() {
  const { continueMethod } = useMfaPhoneChallenge();
  return (
    <button onClick={() => continueMethod({ type: 'sms' })}>
      Send Code via SMS
    </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-phone-challenge. Importez-les depuis @auth0/auth0-acul-react/mfa-phone-challenge.

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

Ce hook fournit les configurations liées à l’application, comme id, name et logoUrl, pour l’écran mfa-phone-challenge.

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaPhoneChallenge

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

Example

import { useScreen } from '@auth0/auth0-acul-react/mfa-phone-challenge';
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-phone-challenge';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook donne accès aux 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-phone-challenge';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

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

Example

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

useMfaPhoneChallenge · MfaPhoneChallengeMembers

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

​

Méthodes

continueMethod · Promise<void>

Cette méthode lance la vérification par téléphone en envoyant un code de vérification au téléphone de l’utilisateur selon le mode d’envoi indiqué.

Example

import { useMfaPhoneChallenge } from '@auth0/auth0-acul-react/mfa-phone-challenge';

function PhoneChallengeForm() {
  const { continueMethod } = useMfaPhoneChallenge();
  return (
    <button onClick={() => continueMethod({ type: 'sms' })}>
      Send Code via SMS
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

MfaPhoneChallengeContinueOptions.

type · "sms" | "voice" · requis

Le type de vérification à effectuer.

• sms : envoyer le code par message texte.
• voice : envoyer le code par appel vocal.

​

Par défaut

'sms'

pickPhone · Promise<void>

Cette méthode redirige vers l’écran de sélection du numéro de téléphone afin que l’utilisateur puisse choisir le numéro à utiliser pour la vérification.

Example

import { useMfaPhoneChallenge } from '@auth0/auth0-acul-react/mfa-phone-challenge';

function PickPhoneButton() {
  const { pickPhone } = useMfaPhoneChallenge();
  return (
    <button onClick={() => pickPhone()}>
      Choose Phone Number
    </button>
  );
}

tryAnotherMethod · Promise<void>

Cette méthode redirige vers l’écran de sélection de la méthode MFA afin que l’utilisateur puisse choisir un autre facteur d’authentification.

Example

import { useMfaPhoneChallenge } from '@auth0/auth0-acul-react/mfa-phone-challenge';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useMfaPhoneChallenge();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Try Another Method
    </button>
  );
}

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration aplatie provenant 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 de l’écran actuel.

useErrors · Hooks

Ce hook permet de lire et de gérer les erreurs du serveur, de l’application et du développeur affichées à l’écran.