MfaBeginEnrollOptions

Describe los hooks y métodos disponibles para personalizar la pantalla mfa-begin-enroll-options de Universal Login.

La pantalla mfa-begin-enroll-options muestra al usuario las opciones disponibles para inscribirse en la autenticación multifactor y le permite seleccionar un factor para inscribirse.

​

Importación

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

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

Import Example

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

// importación parcial
import {
  useMfaBeginEnrollOptions,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  enroll,
} from "@auth0/auth0-acul-react/mfa-begin-enroll-options";

function MfaBeginEnrollOptionsScreen() {
  const { enroll } = useMfaBeginEnrollOptions();
  return (
    <button onClick={() => enroll({ action: 'otp' })}>
      Inscribirse con la aplicación de autenticación
    </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-begin-enroll-options. Impórtelos desde @auth0/auth0-acul-react/mfa-begin-enroll-options.

useBranding · () => BrandingMembers

Este hook proporciona configuraciones de marca, como el logotipo, los colores y el tema que se muestran en la pantalla mfa-begin-enroll-options.

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si la inscripción en MFA está dentro del ámbito de una Organización. Devuelve null cuando no existe un contexto de Organización.

Example

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

useScreen · () => ScreenMembers

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

Example

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

useTransaction · () => TransactionMembers

Este hook proporciona datos específicos de la transacción para la pantalla mfa-begin-enroll-options, como los factores de MFA disponibles y el estado actual del flujo.

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook contiene 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-begin-enroll-options';
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-begin-enroll-options';
function UserProfile() {
  const user = useUser();
}

useMfaBeginEnrollOptions · MfaBeginEnrollOptionsMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla mfa-begin-enroll-options.

​

Métodos

enroll · Promise<void>

Este método inicia la inscripción en el factor de MFA seleccionado y avanza el flujo hasta la pantalla de inscripción de ese factor.

Example

import { useMfaBeginEnrollOptions } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';

function EnrollOptions() {
  const { enroll } = useMfaBeginEnrollOptions();
  return (
    <button onClick={() => enroll({ action: 'otp' })}>
      Inscribirse con la aplicación de autenticación
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

MfaEnrollOptions.

action · string · requerido

La acción que indica en qué factor inscribirse. Puede ser “push-notification”, “otp”, “sms”, “phone”, “voice” o “webauthn-roaming”.

​

Hooks comunes/utilitarios

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 de visualización 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.