MfaOtpEnrollmentCode

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

La pantalla mfa-otp-enrollment-code solicita al usuario que introduzca un código de verificación para completar la inscripción de OTP en su aplicación de autenticación.

​

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 paquete, lo que resulta útil cuando quieres una compilación unificada que gestione todas las pantallas posibles.

Import Example

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

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

function MfaOtpEnrollmentCodeScreen() {
  const { continueMethod } = useMfaOtpEnrollmentCode();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Verify 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-otp-enrollment-code. Impórtalos desde @auth0/auth0-acul-react/mfa-otp-enrollment-code.

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaOtpEnrollmentCode

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useMfaOtpEnrollmentCode · MfaOtpEnrollmentCodeMembers

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

​

Métodos

continueMethod · Promise<void>

Este método envía el código OTP introducido por el usuario para completar la inscripción.

Example

import { useMfaOtpEnrollmentCode } from '@auth0/auth0-acul-react/mfa-otp-enrollment-code';

function EnrollmentCodeForm() {
  const { continueMethod } = useMfaOtpEnrollmentCode();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Verificar
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

MfaOtpContinueOptions.

code · string · requerido

El código OTP introducido por el usuario.

toggleView · Promise<void>

Este método alterna la vista en la pantalla mfa-otp-enrollment-code, por ejemplo, entre las vistas de código QR y entrada manual.

Example

import { useMfaOtpEnrollmentCode } from '@auth0/auth0-acul-react/mfa-otp-enrollment-code';

function ToggleViewButton() {
  const { toggleView } = useMfaOtpEnrollmentCode();
  return (
    <button onClick={() => toggleView()}>
      Cambiar vista
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

import { useMfaOtpEnrollmentCode } from '@auth0/auth0-acul-react/mfa-otp-enrollment-code';

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

​

Hooks comunes y utilitarios

useAuth0Themes · Hooks

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

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 de desarrollo en la pantalla.