InterstitialCaptcha

Décrit tous les hooks et toutes les méthodes disponibles pour personnaliser l’écran interstitial-captcha dans Universal Login.

L’écran interstitial-captcha s’affiche lorsqu’un CAPTCHA est requis pendant le flux d’authentification. Il invite l’utilisateur à résoudre le captcha avant de poursuivre.

​

Importation

Chaque écran a 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 bundle, ce qui est utile si vous voulez qu’une build unifiée prenne en charge tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useInterstitialCaptcha,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  submitCaptcha,
} from '@auth0/auth0-acul-react/interstitial-captcha';

function InterstitialCaptchaScreen() {
  const { submitCaptcha } = useInterstitialCaptcha();
  return (
    <button onClick={() => submitCaptcha({ captcha: 'token' })}>Submit</button>
  );
}

​

Hooks de contexte

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

useBranding · () => BrandingMembers

Ce hook fournit la configuration d’image de marque, comme le logo, les couleurs et les paramètres du thème affichés dans l’écran interstitial-captcha.

Example

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

useClient · () => ClientMembers

Ce hook fournit la configuration liée à l’application, comme id, name et logoUrl, pour l’écran interstitial-captcha.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’organisation de l’utilisateur si le défi CAPTCHA est associé à une organisation. Retourne null lorsqu’aucun contexte d’organisation n’est présent.

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembers

Ce hook contient des détails propres à l’écran interstitial-captcha, notamment sa configuration et son contexte.

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook donne accès aux 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/interstitial-captcha';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

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

Example

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

useInterstitialCaptcha · InterstitialCaptchaMembers

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

​

Méthodes

submitCaptcha · Promise<void>

Cette méthode envoie le jeton CAPTCHA afin de compléter la vérification et de poursuivre le flux d’authentification.

Example

import { useInterstitialCaptcha } from '@auth0/auth0-acul-react/interstitial-captcha';

function SubmitButton() {
  const { submitCaptcha } = useInterstitialCaptcha();
  return (
    <button onClick={() => submitCaptcha({ captcha: 'token' })}>
      Continuer
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

SubmitCaptchaOptions.

captcha · string · requis

Le jeton de réponse du CAPTCHA.

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant de modifier 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 permet de lire et de gérer les erreurs du serveur, côté client et de développement sur l’écran.