MfaWebauthnRoamingEnrollment

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

La pantalla mfa-webauthn-roaming-enrollment solicita al usuario que inscriba una clave de seguridad de itinerancia, como una YubiKey u otro autenticador de hardware FIDO2, como factor 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.

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

Import Example

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

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

function MfaWebAuthnRoamingEnrollmentScreen() {
  const { enroll } = useMfaWebAuthnRoamingEnrollment();
  return (
    <button onClick={() => enroll()}>
      Inscribir clave de seguridad
    </button>
  );
}

​

Hooks de contexto

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

useBranding · () => BrandingMembers

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

Example

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

Example

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

Example

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

useScreen · () => ScreenMembersOnMfaWebAuthnRoamingEnrollment

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useMfaWebAuthnRoamingEnrollment · MfaWebAuthnRoamingEnrollmentMembers

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

​

Métodos

enroll · Promise<void>

Este método inicia el proceso de inscripción de la clave de seguridad de itinerancia.

Example

import { useMfaWebAuthnRoamingEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-enrollment';

function EnrollButton() {
  const { enroll } = useMfaWebAuthnRoamingEnrollment();
  return (
    <button onClick={() => enroll()}>
      Inscribir clave de seguridad
    </button>
  );
}

showError · Promise<void>

Este método notifica un error de WebAuthn detectado durante la inscripción de la clave de seguridad.

Example

import { useMfaWebAuthnRoamingEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-enrollment';

function HandleWebAuthnError({ error }) {
  const { showError } = useMfaWebAuthnRoamingEnrollment();
  return (
    <button onClick={() => showError({ error })}>
      Informar del error
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

ShowErrorOptions.

error · WebAuthnErrorDetails · requerido

El objeto de error de la API de WebAuthn (navigator.credentials.create()) que se notificará.

name · string · requerido

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

message · string · requerido

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

tryAnotherMethod · Promise<void>

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

Example

import { useMfaWebAuthnRoamingEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-enrollment';

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

​

Hooks comunes y de utilidad

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