MfaRecoveryCodeEnrollment

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

La pantalla mfa-recovery-code-enrollment muestra un código de recuperación para que el usuario lo guarde y pueda usarlo para acceder a su cuenta si pierde el acceso a su método principal de MFA.

​

Importación

Cada pantalla tiene su propio conjunto de Hooks y métodos. El SDK admite la importación parcial y la importación 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 raíz te permite cargar todas las pantallas desde un único bundle, lo cual resulta útil cuando quieres una compilación unificada que gestione todas las pantallas posibles.

Import Example

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

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

function MfaRecoveryCodeEnrollmentScreen() {
  const { continueMethod } = useMfaRecoveryCodeEnrollment();
  return (
    <button onClick={() => continueMethod({ isCodeCopied: true })}>
      I've Saved My Recovery Code
    </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-recovery-code-enrollment. Impórtalos desde @auth0/auth0-acul-react/mfa-recovery-code-enrollment.

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

import { useClient } from '@auth0/auth0-acul-react/mfa-recovery-code-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á asociado a una Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

useScreen · () => ScreenMembersOnMfaRecoveryCodeEnrollment

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

Example

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

useTenant · () => TenantMembers

Este hook contiene datos del inquilino, como id y los metadatos asociados.

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook proporciona acceso a los 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-recovery-code-enrollment';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

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

Example

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

useMfaRecoveryCodeEnrollment · MfaRecoveryCodeEnrollmentMembers

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

​

Métodos

continueMethod · Promise<void>

Este método confirma que el usuario ha guardado su código de recuperación y continúa con el flujo de inscripción.

Example

import { useMfaRecoveryCodeEnrollment } from '@auth0/auth0-acul-react/mfa-recovery-code-enrollment';

function ContinueButton() {
  const { continueMethod } = useMfaRecoveryCodeEnrollment();
  return (
    <button onClick={() => continueMethod({ isCodeCopied: true })}>
      I've Saved My Recovery Code
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

MfaRecoveryCodeEnrollmentContinueOptions.

isCodeCopied · boolean · requerido

Indica si el usuario ha copiado o guardado su código de recuperación.

​

Hooks comunes/de utilidad

useAuth0Themes · Hooks

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