MfaPhoneEnrollment

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

L’écran mfa-phone-enrollment permet à l’utilisateur d’inscrire un numéro de téléphone pour la MFA par SMS ou appel vocal en saisissant son numéro et en sélectionnant un mode de réception.

​

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 à la racine pour chaque écran.

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

Import Example

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

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

function MfaPhoneEnrollmentScreen() {
  const { continueEnrollment } = useMfaPhoneEnrollment();
  return (
    <button onClick={() => continueEnrollment({ phone: '[phone]', type: 'sms' })}>
      Enroll Phone
    </button>
  );
}

​

Hooks de contexte

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

useBranding · () => BrandingMembers

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

Example

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook expose 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-phone-enrollment';
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-phone-enrollment';
function UserProfile() {
  const user = useUser();
}

useMfaPhoneEnrollment · MfaPhoneEnrollmentMembers

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

​

Méthodes

continueEnrollment · Promise<void>

Cette méthode soumet le numéro de téléphone de l’utilisateur et le mode d’envoi sélectionné pour inscrire ce numéro à la MFA.

Example

import { useMfaPhoneEnrollment } from '@auth0/auth0-acul-react/mfa-phone-enrollment';

function PhoneEnrollmentForm() {
  const { continueEnrollment } = useMfaPhoneEnrollment();
  return (
    <button onClick={() => continueEnrollment({ phone: '[phone]', type: 'sms' })}>
      Enroll Phone
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

MfaPhoneEnrollmentContinueOptions.

phone · string · requis

Le numéro de téléphone à inscrire à la MFA.

type · "sms" | "voice" · requis

Le mode d’envoi du code de vérification.

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

pickCountryCode · Promise<void>

Cette méthode ouvre l’écran de sélection de l’indicatif du pays afin que l’utilisateur puisse choisir l’indicatif de son numéro de téléphone.

Example

import { useMfaPhoneEnrollment } from '@auth0/auth0-acul-react/mfa-phone-enrollment';

function PickCountryCodeButton() {
  const { pickCountryCode } = useMfaPhoneEnrollment();
  return (
    <button onClick={() => pickCountryCode()}>
      Select Country Code
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

import { useMfaPhoneEnrollment } from '@auth0/auth0-acul-react/mfa-phone-enrollment';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useMfaPhoneEnrollment();
  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 à plat provenant du contexte d’image de marque.

useChangeLanguage · Hooks

Ce hook renvoie une fonction qui permet de modifier 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 lit et gère les erreurs serveur, côté client et développeur à l’écran.