MfaWebauthnRoamingChallenge

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

La pantalla mfa-webauthn-roaming-challenge pide al usuario que complete un desafío de MFA con una clave de seguridad de itinerancia, como una YubiKey u otro autenticador de hardware FIDO2.

​

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 cuando quieres una compilación unificada que gestione todas las pantallas posibles.

Import Example

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

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

function MfaWebAuthnRoamingChallengeScreen() {
  const { verify } = useMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => verify({ rememberDevice: true })}>
      Verify with Security Key
    </button>
  );
}

​

Hooks de contexto

Hooks asociados a la pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla mfa-webauthn-roaming-challenge. Impórtalos desde @auth0/auth0-acul-react/mfa-webauthn-roaming-challenge.

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-roaming-challenge.

Example

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

Example

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

Example

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

useScreen · () => ScreenMembersOnMfaWebAuthnRoamingChallenge

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

Example

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

useTransaction · () => TransactionMembers

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

Example

import { useTransaction } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-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 a partir de parámetros de URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-challenge';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

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

Example

import { useUser } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-challenge';
function UserProfile() {
  const user = useUser();
}

useMfaWebAuthnRoamingChallenge · MfaWebAuthnRoamingChallengeMembers

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

​

Métodos

reportWebAuthnError · Promise<void>

Este método notifica un error de WebAuthn detectado durante el desafío con clave de seguridad de itinerancia.

Example

import { useMfaWebAuthnRoamingChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-challenge';

function HandleWebAuthnError({ error }) {
  const { reportWebAuthnError } = useMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => reportWebAuthnError({ error })}>
      Reportar error
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

MfaWebAuthnRoamingChallengeReportErrorOptions.

error · WebAuthnErrorDetails · requerido

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

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 dirige a la pantalla de selección del método MFA para que el usuario pueda elegir otro factor de autenticación.

Example

import { useMfaWebAuthnRoamingChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-challenge';

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

verify · Promise<void>

Este método inicia la verificación con la clave de seguridad de itinerancia para completar el desafío de MFA.

Example

import { useMfaWebAuthnRoamingChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-challenge';

function VerifyButton() {
  const { verify } = useMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => verify({ rememberDevice: true })}>
      Verificar con clave de seguridad
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

VerifySecurityKeyOptions.

rememberDevice · boolean

Opcional. Si es true, intenta recordar el navegador para futuros desafíos de MFA. Corresponde al campo de formulario rememberBrowser.

​

Hooks comunes y de utilidad

useAuth0Themes · Hooks

Este hook obtiene las opciones actuales del tema con la configuración consolidada 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 permite leer y gestionar los errores del servidor, del cliente y del desarrollador en la pantalla.