ResetPasswordMfaWebauthnRoamingChallenge

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

La pantalla reset-password-mfa-webauthn-roaming-challenge se muestra durante el flujo de restablecimiento de contraseña cuando se requiere autenticación multifactor mediante una clave de seguridad. Indica al usuario que se autentique con su clave de seguridad de hardware externa para continuar con el proceso de restablecimiento.

​

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.

• Usar la importación parcial te permite incluir solo el código que necesitas para tu caso de uso específico.
• Usar la importación desde la raíz te permite cargar todas las pantallas desde un único bundle, lo que resulta útil cuando quieres una compilación unificada para gestionar todas las pantallas posibles.

Import Example

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

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

function ResetPasswordMfaWebAuthnRoamingChallengeScreen() {
  const { useSecurityKey } = useResetPasswordMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => useSecurityKey()}>
      Authenticate 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 reset-password-mfa-webauthn-roaming-challenge. Impórtalos desde @auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge.

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 reset-password-mfa-webauthn-roaming-challenge.

Example

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

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el restablecimiento de contraseña está asociado a una Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

useScreen · () => ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge

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

Example

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

useTransaction · () => TransactionMembers

Este hook proporciona datos específicos de la transacción para la pantalla reset-password-mfa-webauthn-roaming-challenge, como las conexiones activas y el estado actual del flujo.

Example

import { useTransaction } from '@auth0/auth0-acul-react/reset-password-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 un correo electrónico o un nombre de usuario precargados desde parámetros de la URL.

Example

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

useResetPasswordMfaWebAuthnRoamingChallenge · ResetPasswordMfaWebAuthnRoamingChallengeMembers

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

​

Métodos

showError · Promise<void>

Este método informa a Auth0 sobre un error del navegador relacionado con WebAuthn cuando falla el desafío de la clave de seguridad en el dispositivo del usuario.

Example

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

function HandleSecurityKeyError() {
  const { showError } = useResetPasswordMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => showError({ error: { name: 'NotAllowedError', message: 'User cancelled' } })}>
      Report Error
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.

rememberDevice? · boolean

Si es true y screen.showRememberDevice también es true, omite MFA en inicios de sesión posteriores desde el navegador actual.

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 dirige al usuario a seleccionar un método de MFA diferente.

Example

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

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

Parámetros del método

Mostrar Parámetros

options

ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.

rememberDevice? · boolean

Si es true y screen.showRememberDevice también es true, omite MFA en inicios de sesión posteriores desde el navegador actual.

useSecurityKey · Promise<void>

Este método inicia el desafío de la clave de seguridad para continuar el paso de MFA en el flujo de restablecimiento de contraseña.

Example

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

function UseSecurityKeyButton() {
  const { useSecurityKey } = useResetPasswordMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => useSecurityKey()}>
      Autenticarse con clave de seguridad
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.

rememberDevice? · boolean

Si es true y screen.showRememberDevice también es true, omite MFA en inicios de sesión posteriores desde el navegador actual.

​

Hooks comunes/de utilidad

useAuth0Themes · Hooks

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