PhoneIdentifierChallenge

Décrit tous les hooks et toutes les méthodes permettant de personnaliser l’écran phone-identifier-challenge de Universal Login.

L’écran phone-identifier-challenge s’affiche lorsqu’un utilisateur doit vérifier son numéro de téléphone en entrant un code à usage unique. Il permet à l’utilisateur d’envoyer le code, d’en demander le renvoi, de passer de l’envoi par SMS à l’appel vocal, ou de revenir à l’étape précédente.

​

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’utilisation de l’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’usage.
• L’utilisation de l’importation depuis la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez qu’une version unifiée prenne en charge tous les écrans possibles.

Import Example

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

// importation partielle
import {
  usePhoneIdentifierChallenge,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useResend,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  submitPhoneChallenge,
  resendCode,
  returnToPrevious,
  switchToText,
  switchToVoice,
  switchToPassword,
} from '@auth0/auth0-acul-react/phone-identifier-challenge';

function PhoneIdentifierChallengeScreen() {
  const { submitPhoneChallenge } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => submitPhoneChallenge({ code: '123456' })}>Verify</button>
  );
}

​

Hooks de contexte

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

useBranding · () => BrandingMembers

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

Example

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

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’Organization de l’utilisateur si le défi téléphonique est propre à une Organization. Retourne null lorsqu’aucun contexte d’Organization n’est présent.

Example

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

useScreen · () => ScreenMembersOnPhoneIdentifierChallenge

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

Example

import { useScreen } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

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

Example

import { useTenant } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

Ce hook fournit des données propres à la transaction pour l’écran phone-identifier-challenge, comme les connexions actives et l’état actuel du flux.

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook gère les données non fiables transmises à l’écran, comme des paramètres préremplis provenant de la chaîne de requête de l’URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/phone-identifier-challenge';
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/phone-identifier-challenge';
function UserProfile() {
  const user = useUser();
}

usePhoneIdentifierChallenge · PhoneIdentifierChallengeMembers

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

​

Méthodes

submitPhoneChallenge · Promise<void>

Cette méthode soumet le code à usage unique saisi par l’utilisateur pour vérifier son numéro de téléphone et poursuivre le flux d’authentification.

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function VerifyButton() {
  const { submitPhoneChallenge } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => submitPhoneChallenge({ code: '123456' })}>
      Verify
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

PhoneChallengeOptions.

code · string · requis

Le code de vérification envoyé au numéro de téléphone de l’utilisateur.

captcha? · string

Le jeton de réponse CAPTCHA, si le CAPTCHA est activé pour ce tenant.

resendCode · Promise<void>

Cette méthode effectue le renvoi du code à usage unique au numéro de téléphone de l’utilisateur.

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function ResendButton() {
  const { resendCode } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => resendCode()}>
      Resend Code
    </button>
  );
}

returnToPrevious · Promise<void>

Cette méthode redirige l’utilisateur vers l’étape précédente du flux d’authentification.

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function BackButton() {
  const { returnToPrevious } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => returnToPrevious()}>
      Back
    </button>
  );
}

switchToText · Promise<void>

Cette méthode bascule le mode d’envoi de la vérification du téléphone vers un SMS.

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function SwitchToSmsButton() {
  const { switchToText } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => switchToText()}>
      Send via SMS
    </button>
  );
}

switchToVoice · Promise<void>

Cette méthode bascule le mode d’envoi de la vérification du téléphone vers un appel vocal.

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function SwitchToVoiceButton() {
  const { switchToVoice } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => switchToVoice()}>
      Send via Voice Call
    </button>
  );
}

switchToPassword · Promise<void>

Cette méthode bascule du Phone OTP à l’authentification par mot de passe.

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function SwitchToPasswordButton() {
  const { switchToPassword } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => switchToPassword()}>
      Use password instead
    </button>
  );
}

​

Hooks communs/utilitaires

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

Ce hook retourne 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 serveur, client et développeur à l’écran.

useResend · Hooks

Ce hook gère l’état et le minuteur du délai d’attente pour le renvoi de la méthode resendCode.