MfaWebauthnPlatformChallenge

Describe todos los hooks y métodos disponibles para personalizar la pantalla mfa-webauthn-platform-challenge de Universal Login.

La pantalla mfa-webauthn-platform-challenge solicita al usuario que complete un desafío de MFA mediante un autenticador de plataforma, como Touch ID o Windows Hello, integrado en su dispositivo.

​

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 te permite incluir solo el código que necesitas para tu caso de uso específico.
• 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 única que gestione todas las pantallas posibles.

Import Example

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

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

function MfaWebAuthnPlatformChallengeScreen() {
  const { verify } = useMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => verify({ rememberDevice: true })}>
      Verify with Platform 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-webauthn-platform-challenge. Impórtalos desde @auth0/auth0-acul-react/mfa-webauthn-platform-challenge.

useBranding · () => BrandingMembers

Este hook proporciona configuraciones de marca, como el logotipo, los colores y los ajustes del tema que se muestran en la pantalla mfa-webauthn-platform-challenge.

Example

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

Example

import { useClient } from '@auth0/auth0-acul-react/mfa-webauthn-platform-challenge';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaWebAuthnPlatformChallenge

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useMfaWebAuthnPlatformChallenge · MfaWebAuthnPlatformChallengeMembers

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

​

Métodos

reportBrowserError · Promise<void>

Este método informa de un error de WebAuthn a nivel del navegador detectado durante el desafío del autenticador de plataforma.

Example

import { useMfaWebAuthnPlatformChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-platform-challenge';

function HandleWebAuthnError({ error }) {
  const { reportBrowserError } = useMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => reportBrowserError({ error })}>
      Informar error
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

MfaWebAuthnPlatformChallengeReportErrorOptions.

error · WebAuthnErrorDetails · requerido

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

name · string · requerido

El nombre del error (por ejemplo, 'NotAllowedError').

message · string · requerido

El mensaje de error que describe qué salió mal.

tryAnotherMethod · Promise<void>

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

Example

import { useMfaWebAuthnPlatformChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-platform-challenge';

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

verify · Promise<void>

Este método inicia la verificación del autenticador de plataforma para completar el desafío de MFA.

Example

import { useMfaWebAuthnPlatformChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-platform-challenge';

function VerifyButton() {
  const { verify } = useMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => verify({ rememberDevice: true })}>
      Verificar con autenticador de plataforma
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

VerifyPlatformAuthenticatorOptions.

rememberDevice · boolean

Opcional. Si es true, intenta recordar el navegador para futuros desafíos de MFA. Corresponde al campo del formulario rememberBrowser. Esto solo se aplica si screen.showRememberDevice es true.

​

Hooks comunes y de utilidad

useAuth0Themes · Hooks

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