PasskeyEnrollmentLocal

Describe todos los hooks y métodos disponibles para personalizar la pantalla passkey-enrollment-local de Universal Login.

La pantalla passkey-enrollment-local se muestra cuando se le pide a un usuario que inscriba una clave de acceso en su dispositivo actual. Permite al usuario continuar con la inscripción de la clave de acceso o cancelar el proceso y, opcionalmente, evitar que se muestren solicitudes en el futuro.

​

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 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 { usePasskeyEnrollmentLocal } from '@auth0/auth0-acul-react';

// importación parcial
import {
  usePasskeyEnrollmentLocal,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  continuePasskeyEnrollment,
  abortPasskeyEnrollment,
} from '@auth0/auth0-acul-react/passkey-enrollment-local';

function PasskeyEnrollmentLocalScreen() {
  const { continuePasskeyEnrollment } = usePasskeyEnrollmentLocal();
  return (
    <button onClick={() => continuePasskeyEnrollment()}>Enroll Passkey</button>
  );
}

​

Hooks de contexto

Hooks con ámbito de pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla passkey-enrollment-local. Impórtalos desde @auth0/auth0-acul-react/passkey-enrollment-local.

useBranding · () => BrandingMembers

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

Example

import { useBranding } from '@auth0/auth0-acul-react/passkey-enrollment-local';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

Este hook proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla passkey-enrollment-local.

Example

import { useClient } from '@auth0/auth0-acul-react/passkey-enrollment-local';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la organización del usuario si la inscripción de clave de acceso está dentro del ámbito de una organización. Devuelve null cuando no hay contexto de organización.

Example

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

useScreen · () => ScreenMembersOnPasskeyEnrollmentLocal

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

Este hook proporciona datos específicos de la transacción para la pantalla passkey-enrollment-local, como las conexiones activas y el estado actual del flujo.

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook administra los datos no confiables que se pasan a la pantalla, como los parámetros precompletados de la cadena de consulta de la URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/passkey-enrollment-local';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

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

Example

import { useUser } from '@auth0/auth0-acul-react/passkey-enrollment-local';
function UserProfile() {
  const user = useUser();
}

usePasskeyEnrollmentLocal · PasskeyEnrollmentLocalMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla passkey-enrollment-local.

​

Métodos

continuePasskeyEnrollment · Promise<void>

Este método inicia el proceso de inscripción de una clave de acceso en el dispositivo actual y continúa el flujo de autenticación.

Example

import { usePasskeyEnrollmentLocal } from '@auth0/auth0-acul-react/passkey-enrollment-local';

function EnrollButton() {
  const { continuePasskeyEnrollment } = usePasskeyEnrollmentLocal();
  return (
    <button onClick={() => continuePasskeyEnrollment()}>
      Registrar clave de acceso
    </button>
  );
}

abortPasskeyEnrollment · Promise<void>

Este método cancela el proceso de inscripción de la clave de acceso y continúa el flujo de autenticación sin inscribir una clave de acceso.

Example

import { usePasskeyEnrollmentLocal } from '@auth0/auth0-acul-react/passkey-enrollment-local';

function SkipButton() {
  const { abortPasskeyEnrollment } = usePasskeyEnrollmentLocal();
  return (
    <button onClick={() => abortPasskeyEnrollment({ doNotShowAgain: true })}>
      Omitir y no volver a preguntar
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

AbortEnrollmentOptions.

doNotShowAgain · boolean

Cuando es true, suprime futuras solicitudes de inscripción de claves de acceso para este usuario.

​

Hooks comunes y utilitarios

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración plana 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.