Confirmation

Décrit tous les hooks et méthodes permettant de personnaliser l’écran confirmation de Universal Login.

L’écran confirmation s’affiche après la vérification par OTP lorsqu’Auth0 détecte une possibilité d’inscription automatique, permettant à l’utilisateur de confirmer ou de refuser la création d’un compte.

​

Importation

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

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation à la racine vous permet de charger tous les écrans à partir d’un seul module, ce qui est utile lorsqu’une compilation unifiée doit gérer tous les écrans possibles.

Import Example

// root import
import { useConfirmation } from '@auth0/auth0-acul-react';

// partial import
import {
  useConfirmation,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
  // Méthodes
  proceedToSignup,
  goBack,
} from '@auth0/auth0-acul-react/confirmation';

function ConfirmationScreen() {
  const { proceedToSignup } = useConfirmation();
  return (
    <button onClick={() => proceedToSignup()}>
      Create Account
    </button>
  );
}

​

Hooks de contexte

Hooks associés à l’écran qui donnent un accès en lecture seule aux données de contexte Auth0 de l’écran confirmation. Importez-les depuis @auth0/auth0-acul-react/confirmation.

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

Ce hook fournit les configurations du client, comme id, name et logoUrl, pour l’écran confirmation.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’Organization de l’utilisateur. Il renvoie null lorsqu’aucun contexte d’Organization n’est présent.

Example

import { useOrganization } from '@auth0/auth0-acul-react/confirmation';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}

usePrompt · () => PromptMembers

Ce hook contient des données sur le prompt actuel du flux d’authentification.

Example

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

useScreen · () => ScreenMembers

Ce hook contient des renseignements propres à l’écran confirmation, y compris sa configuration et son contexte.

Example

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

useTenant · () => TenantMembers

Ce hook contient des données sur le tenant, comme son id et les métadonnées associées.

Example

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

useTransaction · () => TransactionMembers

Ce hook fournit des données propres à la transaction pour l’écran confirmation, comme les identifiants actifs et les états du flow.

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook traite les données non fiables transmises à l’écran, comme les champs préremplis à partir de paramètres d’URL.

Example

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

useUser · () => UserMembers

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

Example

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

useConfirmation · ConfirmationMembers

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

​

Méthodes

proceedToSignup · Promise<void>

Cette méthode confirme l’inscription automatique et crée le compte après la vérification par OTP.

Example

import { useConfirmation } from '@auth0/auth0-acul-react/confirmation';

function ConfirmButton() {
  const { proceedToSignup } = useConfirmation();
  return (
    <button onClick={() => proceedToSignup()}>
      Create Account
    </button>
  );
}

goBack · Promise<void>

Cette méthode refuse l’inscription automatique et ramène l’utilisateur à l’écran de connexion sans créer de compte.

Example

import { useConfirmation } from '@auth0/auth0-acul-react/confirmation';

function CancelButton() {
  const { goBack } = useConfirmation();
  return (
    <button onClick={() => goBack()}>
      Go Back
    </button>
  );
}

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel, avec une configuration aplatie issue du contexte d’image de marque.

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

Ce hook lit et gère les erreurs du serveur, du client et du développeur affichées à l’écran.