MfaWebauthnPlatformEnrollment

Describe todos los hooks y métodos disponibles para personalizar la pantalla mfa-webauthn-platform-enrollment de Inicio de Sesión Universal.

La pantalla mfa-webauthn-platform-enrollment solicita al usuario que registre un autenticador de plataforma, como Touch ID o Windows Hello, como factor de MFA.

​

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 te permite incluir solo el código que necesitas para tu caso de uso.
• La importación desde la raíz te permite cargar todas las pantallas desde un único paquete, lo que resulta útil si quieres una compilación unificada que gestione todas las pantallas posibles.

Import Example

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

// importación parcial
import {
  useMfaWebAuthnPlatformEnrollment,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  refuseEnrollmentOnThisDevice,
  reportBrowserError,
  snoozeEnrollment,
  submitPasskeyCredential,
} from "@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment";

function MfaWebAuthnPlatformEnrollmentScreen() {
  const { submitPasskeyCredential } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => submitPasskeyCredential()}>
      Enroll Platform Authenticator
    </button>
  );
}

​

Hooks de contexto

Hooks con alcance a nivel de pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla mfa-webauthn-platform-enrollment. Impórtalos desde @auth0/auth0-acul-react/mfa-webauthn-platform-enrollment.

useBranding · () => BrandingMembers

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

Example

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

Example

import { useClient } from '@auth0/auth0-acul-react/mfa-webauthn-platform-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á limitado a una Organization. Devuelve null cuando no hay contexto de Organization.

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}

usePrompt · () => PromptMembers

Este hook contiene datos sobre el prompt actual dentro del flujo de autenticación.

Example

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

useScreen · () => ScreenMembersOnMfaWebAuthnPlatformEnrollment

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useMfaWebAuthnPlatformEnrollment · MfaWebAuthnPlatformEnrollmentMembers

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

​

Métodos

refuseEnrollmentOnThisDevice · Promise<void>

Este método rechaza la inscripción del autenticador de plataforma en el dispositivo actual.

Example

import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function RefuseEnrollmentButton() {
  const { refuseEnrollmentOnThisDevice } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => refuseEnrollmentOnThisDevice()}>
      Not on This Device
    </button>
  );
}

reportBrowserError · Promise<void>

Este método reporta un error de WebAuthn a nivel del navegador detectado durante la inscripción del autenticador de plataforma.

Example

import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function HandleWebAuthnError({ error }) {
  const { reportBrowserError } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => reportBrowserError({ error })}>
      Report Error
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

ReportBrowserErrorOptions.

error · WebAuthnErrorDetails · requerido

El objeto de error de la API de WebAuthn (navigator.credentials.create()) que se va a reportar.

name · string · requerido

El nombre del error (p. ej., 'NotAllowedError').

message · string · requerido

El mensaje de error que describe lo que salió mal.

snoozeEnrollment · Promise<void>

Este método pospone la inscripción del autenticador de plataforma para otro momento.

Example

import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function SnoozeButton() {
  const { snoozeEnrollment } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => snoozeEnrollment()}>
      Remind Me Later
    </button>
  );
}

submitPasskeyCredential · Promise<void>

Este método envía la credencial de passkey creada por el autenticador de plataforma para completar la inscripción.

Example

import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function EnrollButton() {
  const { submitPasskeyCredential } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => submitPasskeyCredential()}>
      Enroll Platform Authenticator
    </button>
  );
}

​

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