PasskeyEnrollment

Décrit tous les hooks et toutes les méthodes disponibles pour personnaliser l’écran passkey-enrollment de Universal Login.

L’écran passkey-enrollment s’affiche lorsqu’un utilisateur est invité à inscrire une clé d’accès comme méthode d’authentification. Il permet à l’utilisateur de poursuivre l’inscription de la clé d’accès ou d’interrompre le processus.

​

Importation

Chaque écran a son propre ensemble de hooks et de méthodes. Le SDK prend en charge l’importation partielle et l’importation depuis la racine pour chaque écran.

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation depuis la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez qu’une compilation unifiée prenne en charge tous les écrans possibles.

Import Example

// importation racine
import { usePasskeyEnrollment } from '@auth0/auth0-acul-react';

// importation partielle
import {
  usePasskeyEnrollment,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  continuePasskeyEnrollment,
  abortPasskeyEnrollment,
  doNotShowAgain,
} from '@auth0/auth0-acul-react/passkey-enrollment';

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

​

Hooks de contexte

Hooks propres à l’écran qui fournissent un accès en lecture seule aux données de contexte d’Auth0 pour l’écran passkey-enrollment. Importez-les depuis @auth0/auth0-acul-react/passkey-enrollment.

useBranding · () => BrandingMembers

Ce hook fournit les paramètres d’image de marque, comme le logo, les couleurs et les paramètres du thème affichés sur l’écran passkey-enrollment.

Example

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

useClient · () => ClientMembers

Ce hook fournit les configurations liées à l’application, comme id, name et logoUrl, pour l’écran passkey-enrollment.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’Organisation de l’utilisateur si l’inscription de la clé d’accès est associée à une Organisation. Retourne null lorsqu’aucun contexte d’Organisation n’est présent.

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

Ce hook contient des données sur l’invite actuelle dans le flux d’authentification.

Example

import { usePrompt } from '@auth0/auth0-acul-react/passkey-enrollment';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnPasskeyEnrollment

Ce hook contient des détails propres à l’écran passkey-enrollment, y compris sa configuration et son contexte.

Example

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

useTenant · () => TenantMembers

Ce hook contient des données liées au locataire, comme id et les métadonnées associées.

Example

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

useTransaction · () => TransactionMembers

Ce hook fournit des données propres à la transaction pour l’écran passkey-enrollment, comme les connexions actives et l’état actuel du flux.

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook gère les données non fiables transmises à l’écran, comme les paramètres préremplis provenant des chaînes de requête de l’URL.

Example

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

useUser · () => UserMembers

Ce hook fournit des renseignements sur l’utilisateur actif, notamment username, email et les méthodes d’authentification disponibles.

Exemple

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

usePasskeyEnrollment · PasskeyEnrollmentMembers

Ce hook renvoie toutes les méthodes et tout le contexte disponibles dans l’écran passkey-enrollment.

​

Méthodes

continuePasskeyEnrollment · Promise<void>

Cette méthode démarre le processus d’inscription de la clé d’accès et poursuit le flux d’authentification.

Example

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

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

abortPasskeyEnrollment · Promise<void>

Cette méthode annule le processus d’inscription de la clé d’accès et poursuit le flux d’authentification sans inscrire de clé d’accès.

Example

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

function SkipButton() {
  const { abortPasskeyEnrollment } = usePasskeyEnrollment();
  return (
    <button onClick={() => abortPasskeyEnrollment()}>
      Skip for Now
    </button>
  );
}

doNotShowAgain · Promise<void>

Cette méthode ignore l’inscription de la clé d’accès et enregistre la préférence de l’utilisateur afin qu’on ne lui demande plus d’inscrire une clé d’accès.

Example

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

function DoNotShowAgainButton() {
  const { doNotShowAgain } = usePasskeyEnrollment();
  return (
    <button onClick={() => doNotShowAgain()}>
      Don't show this again
    </button>
  );
}

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options de thème actuelles avec une configuration aplatie à partir du contexte d’image de marque.

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant de modifier la langue d’affichage sur l’écran ACUL actuel.

useCurrentScreen · Hooks

Ce hook récupère le contexte et l’état de l’écran actuel.

useErrors · Hooks

Ce hook permet de lire et de gérer les erreurs du serveur, de l’application et du développeur sur l’écran.