MfaSmsEnrollment

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

La pantalla mfa-sms-enrollment permite al usuario inscribir un número de teléfono en MFA por SMS introduciendo su número y seleccionando un método de envío.

​

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 { useMfaSmsEnrollment } from '@auth0/auth0-acul-react';

// importación parcial
import {
  useMfaSmsEnrollment,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  continueEnrollment,
  pickCountryCode,
  tryAnotherMethod,
} from "@auth0/auth0-acul-react/mfa-sms-enrollment";

function MfaSmsEnrollmentScreen() {
  const { continueEnrollment } = useMfaSmsEnrollment();
  return (
    <button onClick={() => continueEnrollment({ phone: '[phone]' })}>
      Inscribir número de teléfono
    </button>
  );
}

​

Hooks de contexto

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

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-enrollment.

Example

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

useClient · () => ClientMembers

Este hook proporciona configuración relacionada con el cliente, como id, name y logoUrl, para la pantalla mfa-sms-enrollment.

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaSmsEnrollment

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaSmsEnrollment · MfaSmsEnrollmentMembers

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

​

Métodos

continueEnrollment · Promise<void>

Este método envía el número de teléfono del usuario para completar la inscripción en MFA mediante SMS.

Example

import { useMfaSmsEnrollment } from '@auth0/auth0-acul-react/mfa-sms-enrollment';

function EnrollPhoneForm() {
  const { continueEnrollment } = useMfaSmsEnrollment();
  return (
    <button onClick={() => continueEnrollment({ phone: '[phone]' })}>
      Inscribir número de teléfono
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

MfaSmsEnrollmentContinueOptions.

phone · string · requerido

El número de teléfono del usuario.

captcha · string

Token de captcha opcional para la verificación.

pickCountryCode · Promise<void>

Este método redirige a la pantalla de selección del código de país.

Example

import { useMfaSmsEnrollment } from '@auth0/auth0-acul-react/mfa-sms-enrollment';

function PickCountryCodeButton() {
  const { pickCountryCode } = useMfaSmsEnrollment();
  return (
    <button onClick={() => pickCountryCode()}>
      Seleccionar código de país
    </button>
  );
}

tryAnotherMethod · Promise<void>

Este método redirige 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 { useMfaSmsEnrollment } from '@auth0/auth0-acul-react/mfa-sms-enrollment';

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

​

Hooks comunes y de utilidad

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

Este hook devuelve una función para cambiar el idioma que se muestra 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.