MfaPhoneEnrollment

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

La pantalla mfa-phone-enrollment permite al usuario inscribir un número de teléfono para MFA por SMS o voz introduciendo su número y seleccionando un método de entrega.

​

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

// importación parcial
import {
  useMfaPhoneEnrollment,
  // 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-phone-enrollment";

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

​

Hooks de contexto

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

useBranding · () => BrandingMembers

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

Example

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

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el flujo de MFA tiene alcance de Organización. Devuelve null cuando no hay contexto de Organización.

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

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

Example

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

useScreen · () => ScreenMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useMfaPhoneEnrollment · MfaPhoneEnrollmentMembers

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

​

Métodos

continueEnrollment · Promise<void>

Este método envía el número de teléfono del usuario y el método de entrega seleccionado para inscribir el teléfono en 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>
  );
}

Parámetros del método

Mostrar Parámetros

options

MfaPhoneEnrollmentContinueOptions.

phone · string · requerido

El número de teléfono que se inscribirá en MFA.

type · "sms" | "voice" · requerido

El método de entrega del código de verificación.

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

pickCountryCode · Promise<void>

Este método lleva a la pantalla de selección de código de país para que el usuario pueda elegir el código de país de su número de teléfono.

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>

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

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

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración aplanada 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 permite leer y gestionar los errores del servidor, del cliente y del desarrollador en la pantalla.