MfaPushEnrollmentQr

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

La pantalla mfa-push-enrollment-qr muestra un código QR para que el usuario lo escanee con la aplicación Auth0 Guardian y complete la inscripción para las notificaciones push.

​

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

Import Example

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

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

function MfaPushEnrollmentQrScreen() {
  const { pickAuthenticator } = useMfaPushEnrollmentQr();
  return (
    <button onClick={() => pickAuthenticator()}>
      Pick Authenticator
    </button>
  );
}

​

Hooks de contexto

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

useBranding · () => BrandingMembers

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

Example

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

Example

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-push-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 del flujo de autenticación.

Example

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

useScreen · () => ScreenMembersOnMfaPushEnrollmentQr

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/mfa-push-enrollment-qr';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

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

Example

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

useMfaPushEnrollmentQr · MfaPushEnrollmentQrMembers

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

​

Métodos

continueMethod · Promise<void>

Este método completa la inscripción en push después de que el usuario haya escaneado el código QR con la aplicación Auth0 Guardian.

Example

import { useMfaPushEnrollmentQr } from '@auth0/auth0-acul-react/mfa-push-enrollment-qr';

function ContinueButton() {
  const { continueMethod } = useMfaPushEnrollmentQr();
  return (
    <button onClick={() => continueMethod({ rememberDevice: true })}>
      Continuar
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

MfaPushEnrollmentQrWithRememberOptions.

rememberDevice? · boolean

Si es true, se recordará el dispositivo y no se volverá a requerir MFA en él.

pickAuthenticator · Promise<void>

Este método lleva a la pantalla de selección del autenticador para que el usuario pueda elegir otro método de MFA para inscribirse.

Example

import { useMfaPushEnrollmentQr } from '@auth0/auth0-acul-react/mfa-push-enrollment-qr';

function PickAuthenticatorButton() {
  const { pickAuthenticator } = useMfaPushEnrollmentQr();
  return (
    <button onClick={() => pickAuthenticator()}>
      Elegir autenticador
    </button>
  );
}

​

Hooks comunes y de utilidad

useMfaPolling · Hooks

Este hook administra el estado de sondeo para las pantallas que esperan una respuesta asíncrona de una notificación push.

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 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 gestiona los errores del servidor, del lado del cliente y del desarrollador en la pantalla.