MfaPhoneChallenge

Describe todos los Hooks y métodos disponibles para personalizar la pantalla mfa-phone-challenge de Universal Login.

La pantalla mfa-phone-challenge solicita al usuario que verifique su identidad introduciendo un code enviado a su teléfono por SMS o mediante una llamada de voz.

​

Importación

Cada pantalla tiene su propio conjunto de hooks y métodos. El SDK admite la importación parcial y la importación desde la raíz para cada pantalla.

• La importación parcial te permite incluir solo el código que necesitas para tu caso de uso.
• La importación desde la raíz te permite cargar todas las pantallas desde un único paquete, lo que resulta útil cuando quieres una compilación unificada para gestionar todas las pantallas posibles.

Import Example

// importación raíz
import { useMfaPhoneChallenge } from '@auth0/auth0-acul-react';

// importación parcial
import {
  useMfaPhoneChallenge,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  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 contexto

Hooks específicos de la pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla mfa-phone-challenge. Impórtelos desde @auth0/auth0-acul-react/mfa-phone-challenge.

useBranding · () => BrandingMembers

Este hook proporciona configuraciones de marca, como el logotipo, los colores y los ajustes del tema que se muestran en la pantalla mfa-phone-challenge.

Example

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

useClient · () => ClientMembers

Este hook proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla mfa-phone-challenge.

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el flujo de MFA está asociado a una Organización. Devuelve null cuando no hay contexto de Organización.

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

Este hook contiene datos sobre la pantalla actual del flujo de autenticación.

Example

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

useScreen · () => ScreenMembersOnMfaPhoneChallenge

Este hook contiene detalles específicos de la pantalla mfa-phone-challenge, incluida su configuración y contexto.

Example

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

useTenant · () => TenantMembers

Este hook contiene datos relacionados con el inquilino, como id y sus metadatos asociados.

Example

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

useTransaction · () => TransactionMembers

Este hook proporciona datos específicos de la transacción para la pantalla mfa-phone-challenge, como el estado actual del flujo de MFA.

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook maneja los datos no confiables que se pasan a la pantalla, como los valores completados previamente a partir de parámetros de URL.

Example

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

useUser · () => UserMembers

Este hook proporciona detalles sobre el usuario activo, incluidos username, email y los métodos de autenticación disponibles.

Example

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

useMfaPhoneChallenge · MfaPhoneChallengeMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla mfa-phone-challenge.

​

Métodos

continueMethod · Promise<void>

Este método inicia la verificación por teléfono enviando un code de verificación al teléfono del usuario mediante el método de entrega especificado.

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>
  );
}

Parámetros del método

Mostrar Parámetros

options

MfaPhoneChallengeContinueOptions.

type · "sms" | "voice" · requerido

El tipo de verificación que se debe realizar.

• sms: Envía el code por mensaje de texto.
• voice: Envía el code mediante una llamada de voz.

​

Predeterminado

'sms'

pickPhone · Promise<void>

Este método navega a la pantalla de selección de número de teléfono para que el usuario pueda elegir qué número usar para la verificación.

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>

Este método navega a la pantalla de selección del método de MFA para que el usuario pueda elegir un factor de autenticación distinto.

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 comunes y de utilidad

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración consolidada del contexto de marca.

useChangeLanguage · Hooks

Este hook devuelve una función para cambiar el idioma mostrado en la pantalla actual de ACUL.

useCurrentScreen · Hooks

Este hook obtiene el contexto y el estado de la pantalla actual.

useErrors · Hooks

Este hook lee y administra los errores del servidor, del cliente y del desarrollador en la pantalla.