MfaOtpEnrollmentQr

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

La pantalla mfa-otp-enrollment-qr muestra un código QR para que el usuario lo escanee con su aplicación de autenticación y complete la inscripción de OTP.

​

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 le permite incluir solo el código que necesita para su caso de uso.
• La importación desde la raíz le permite cargar todas las pantallas desde un único bundle, lo que resulta útil cuando desea una compilación unificada para gestionar todas las pantallas posibles.

Import Example

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

// importación parcial
import {
  useMfaOtpEnrollmentQr,
  // 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-qr";

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

useBranding · () => BrandingMembers

Este hook proporciona configuraciones de marca, como el logotipo, los colores y los ajustes de tema que se muestran en la pantalla mfa-otp-enrollment-qr.

Example

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

Example

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

useScreen · () => ScreenMembersOnMfaOtpEnrollmentQr

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook maneja 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-otp-enrollment-qr';
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-qr';
function UserProfile() {
  const user = useUser();
}

useMfaOtpEnrollmentQr · MfaOtpEnrollmentQrMembers

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

​

Métodos

continueMethod · Promise<void>

Este método envía el código OTP para verificar que la aplicación de autenticación esté configurada correctamente y completar la inscripción.

Example

import { useMfaOtpEnrollmentQr } from '@auth0/auth0-acul-react/mfa-otp-enrollment-qr';

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

Parámetros del método

Mostrar Parámetros

options

MfaOtpEnrollmentQrContinueOptions.

code · string · requerido

El código OTP introducido por el usuario.

toggleView · Promise<void>

Este método alterna la vista de inscripción entre los modos de código QR y entrada manual (clave secreta).

Example

import { useMfaOtpEnrollmentQr } from '@auth0/auth0-acul-react/mfa-otp-enrollment-qr';

function ToggleViewButton() {
  const { toggleView } = useMfaOtpEnrollmentQr();
  return (
    <button onClick={() => toggleView()}>
      Introducir código manualmente
    </button>
  );
}

tryAnotherMethod · Promise<void>

Este método navega 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 { useMfaOtpEnrollmentQr } from '@auth0/auth0-acul-react/mfa-otp-enrollment-qr';

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

​

Hooks comunes y hook de utilidad

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 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 lee y administra los errores del servidor, del cliente y de desarrollo en la pantalla.