PasskeyEnrollment

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

La pantalla passkey-enrollment se muestra cuando se le pide a un usuario que inscriba una clave de acceso como método de autenticación. Permite al usuario continuar con la inscripción de clave de acceso o cancelar el proceso.

​

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 le permite incluir solo el código que necesita para su caso de uso.
• La importación desde la raíz le permite cargar todas las pantallas desde un único paquete, lo que resulta útil cuando necesita una compilación unificada para gestionar todas las pantallas posibles.

Import Example

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

// importación parcial
import {
  usePasskeyEnrollment,
  // 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,
  doNotShowAgain,
} from '@auth0/auth0-acul-react/passkey-enrollment';

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

​

Hooks de contexto

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

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 passkey-enrollment.

Example

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

useClient · () => ClientMembers

Este hook proporciona la configuración relacionada con el cliente, como id, name y logoUrl, para la pantalla passkey-enrollment.

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si la inscripción de claves de acceso está limitada a una Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

useScreen · () => ScreenMembersOnPasskeyEnrollment

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

Example

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

useTenant · () => TenantMembers

Este hook contiene datos del inquilino, como id y los metadatos asociados.

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook contiene datos no confiables que se pasan a la pantalla, como parámetros rellenados previamente desde la cadena de consulta de la URL.

Example

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

useUser · () => UserMembers

Este hook proporciona detalles 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';
function UserProfile() {
  const user = useUser();
}

usePasskeyEnrollment · PasskeyEnrollmentMembers

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

​

Métodos

continuePasskeyEnrollment · Promise<void>

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

Example

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

function EnrollButton() {
  const { continuePasskeyEnrollment } = usePasskeyEnrollment();
  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 { usePasskeyEnrollment } from '@auth0/auth0-acul-react/passkey-enrollment';

function SkipButton() {
  const { abortPasskeyEnrollment } = usePasskeyEnrollment();
  return (
    <button onClick={() => abortPasskeyEnrollment()}>
      Omitir por ahora
    </button>
  );
}

doNotShowAgain · Promise<void>

Este método omite la inscripción de la clave de acceso y guarda la preferencia del usuario para que no se le vuelva a solicitar que inscriba una clave de acceso.

Example

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

function DoNotShowAgainButton() {
  const { doNotShowAgain } = usePasskeyEnrollment();
  return (
    <button onClick={() => doNotShowAgain()}>
      No volver a mostrar esto
    </button>
  );
}

​

Hooks comunes y de utilidad

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