MfaSmsChallenge

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

La pantalla mfa-sms-challenge solicita al usuario que introduzca un código de un solo uso enviado a su teléfono por SMS para completar la verificación MFA.

​

Importación

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

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

Import Example

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

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

​

Hooks de contexto

Hooks con ámbito de pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla mfa-sms-challenge. Impórtalos desde @auth0/auth0-acul-react/mfa-sms-challenge.

useBranding · () => BrandingMembers

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

Example

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

Example

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

useScreen · () => ScreenMembersOnMfaSmsChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembersOnMfaSmsChallenge

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaSmsChallenge · MfaSmsChallengeMembers

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

​

Métodos

continueMfaSmsChallenge · Promise<void>

Este método envía el código de un solo uso recibido por SMS para completar la verificación de MFA.

Example

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

function VerifyCodeForm() {
  const { continueMfaSmsChallenge } = useMfaSmsChallenge();
  return (
    <button onClick={() => continueMfaSmsChallenge({ code: '123456' })}>
      Verificar código
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

MfaSmsChallengeOptions.

code · string · requerido

El código de un solo uso enviado al teléfono del usuario por SMS.

rememberDevice · boolean

Indica si se debe recordar el dispositivo y omitir MFA en futuros inicios de sesión.

getACall · Promise<void>

Este método cambia la verificación de MFA a una llamada de voz en lugar de un SMS.

Example

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

function GetACallButton() {
  const { getACall } = useMfaSmsChallenge();
  return (
    <button onClick={() => getACall()}>
      Recibir una llamada en su lugar
    </button>
  );
}

pickSms · Promise<void>

Este método navega a la pantalla de selección del número de teléfono para SMS.

Example

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

function PickSmsButton() {
  const { pickSms } = useMfaSmsChallenge();
  return (
    <button onClick={() => pickSms()}>
      Usar otro número de teléfono
    </button>
  );
}

resendCode · Promise<void>

Este método reenvía el código de un solo uso por SMS al teléfono del usuario.

Example

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

function ResendCodeButton() {
  const { resendCode } = useMfaSmsChallenge();
  return (
    <button onClick={() => resendCode()}>
      Reenviar código
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

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

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useMfaSmsChallenge();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Probar otro método
    </button>
  );
}

​

Hooks comunes/de utilidad

useResend · Hooks

Este hook gestiona el estado y la lógica del período de espera para reenviar en pantallas con funcionalidad de reenvío de código.

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 gestiona los errores del servidor, del cliente y del desarrollador en la pantalla.