MfaSmsChallenge

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

L’écran mfa-sms-challenge invite l’utilisateur à saisir un code à usage unique envoyé à son téléphone par SMS pour compléter la vérification AMF.

​

Importation

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

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

Import Example

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

// importation partielle
import {
  useMfaSmsChallenge,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  useResend,
  // Méthodes
  continueMfaSmsChallenge,
  getACall,
  pickSms,
  resendCode,
  tryAnotherMethod,
} from "@auth0/auth0-acul-react/mfa-sms-challenge";

function MfaSmsChallengeScreen() {
  const { continueMfaSmsChallenge } = useMfaSmsChallenge();
  return (
    <button onClick={() => continueMfaSmsChallenge({ code: '123456' })}>
      Verify Code
    </button>
  );
}

​

Context Hooks

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

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-sms-challenge.

Example

import { useBranding } from '@auth0/auth0-acul-react/mfa-sms-challenge';
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-sms-challenge.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’Organization de l’utilisateur si le flux AMF est limité à une Organization. Retourne null lorsqu’aucun contexte d’Organization n’est présent.

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-sms-challenge';
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-sms-challenge';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnMfaSmsChallenge

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembersOnMfaSmsChallenge

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

Example

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

useUser · () => UserMembers

Ce hook fournit des détails sur l’utilisateur actif, y compris le username, l’email et les méthodes d’authentification disponibles.

Example

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

useMfaSmsChallenge · MfaSmsChallengeMembers

Ce hook renvoie toutes les méthodes et tout le contexte disponibles sur l’écran mfa-sms-challenge.

​

Méthodes

continueMfaSmsChallenge · Promise<void>

Cette méthode envoie le code à usage unique reçu par SMS pour terminer la vérification AMF.

Example

import { useMfaSmsChallenge } from '@auth0/auth0-acul-react/mfa-sms-challenge';

function VerifyCodeForm() {
  const { continueMfaSmsChallenge } = useMfaSmsChallenge();
  return (
    <button onClick={() => continueMfaSmsChallenge({ code: '123456' })}>
      Vérifier le code
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

MfaSmsChallengeOptions.

code · string · requis

Le code à usage unique envoyé par SMS au téléphone de l’utilisateur.

rememberDevice · boolean

Indique s’il faut se souvenir de l’appareil et ignorer l’AMF lors des prochaines connexions.

getACall · Promise<void>

Cette méthode remplace la vérification AMF par SMS par un appel vocal.

Example

import { useMfaSmsChallenge } from '@auth0/auth0-acul-react/mfa-sms-challenge';

function GetACallButton() {
  const { getACall } = useMfaSmsChallenge();
  return (
    <button onClick={() => getACall()}>
      Recevoir un appel à la place
    </button>
  );
}

pickSms · Promise<void>

Cette méthode redirige vers l’écran de sélection du numéro de téléphone pour les SMS.

Example

import { useMfaSmsChallenge } from '@auth0/auth0-acul-react/mfa-sms-challenge';

function PickSmsButton() {
  const { pickSms } = useMfaSmsChallenge();
  return (
    <button onClick={() => pickSms()}>
      Utiliser un autre numéro de téléphone
    </button>
  );
}

resendCode · Promise<void>

Cette méthode renvoie le code à usage unique par SMS au téléphone de l’utilisateur.

Example

import { useMfaSmsChallenge } from '@auth0/auth0-acul-react/mfa-sms-challenge';

function ResendCodeButton() {
  const { resendCode } = useMfaSmsChallenge();
  return (
    <button onClick={() => resendCode()}>
      Renvoyer le code
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

import { useMfaSmsChallenge } from '@auth0/auth0-acul-react/mfa-sms-challenge';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useMfaSmsChallenge();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Essayer une autre méthode
    </button>
  );
}

​

Hooks communs et utilitaires

useResend · Hooks

Ce hook gère l’état et la logique du délai de renvoi pour les écrans offrant la fonctionnalité de renvoi de code.

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant 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 du serveur, du client et du développeur à l’écran.