InterstitialCaptcha

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran interstitial-captcha de Universal Login.

La classe InterstitialCaptcha implémente les fonctionnalités de l’écran interstitial-captcha. Cet écran invite l’utilisateur à effectuer un captcha pendant le flux d’authentification.

​

Constructeurs

Créez une instance du gestionnaire de l’écran InterstitialCaptcha :

Example

import InterstitialCaptcha from '@auth0/auth0-acul-js/interstitial-captcha';
const interstitialCaptchaManager = new InterstitialCaptcha();
await interstitialCaptchaManager.submitCaptcha({ captcha: 'captchaValue' });

​

Propriétés

branding · BrandingMembers

Fournit des configurations liées à l’image de marque, comme le thème et les paramètres associés.

client · ClientMembers

Fournit des configurations liées à l’application, comme id, name et logoUrl, pour l’écran interstitial-captcha.

organization · OrganizationMembers

Fournit des renseignements sur l’Organisation de l’utilisateur, comme id et name.

prompt · PromptMembers

Contient des données sur l’invite actuelle dans le flux d’authentification.

screen · ScreenMembers

Contient des détails propres à l’écran interstitial-captcha, y compris sa configuration et son contexte.

tenant · TenantMembers

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

transaction · TransactionMembers

Fournit des données propres à la transaction pour l’écran interstitial-captcha, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Gère les données non fiables transmises au SDK, comme la saisie de l’utilisateur pendant le flux de vérification par captcha.

user · UserMembers

Contient les détails de l’utilisateur actif, y compris username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

Cette méthode modifie la langue d’affichage de la page Universal Login.

Example

import InterstitialCaptcha from '@auth0/auth0-acul-js/interstitial-captcha';
const interstitialCaptchaManager = new InterstitialCaptcha();
interstitialCaptchaManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code régional de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsque cette valeur est définie sur 'session', la langue sélectionnée est conservée pendant toute la session.

getErrors · Error []

Cette méthode récupère le tableau des erreurs de transaction dans le contexte, ou un tableau vide s’il n’y en a aucune.

submitCaptcha · Promise<void>

Cette méthode soumet la réponse du captcha pour poursuivre le flux d’authentification.

Example

import InterstitialCaptcha from '@auth0/auth0-acul-js/interstitial-captcha';
const interstitialCaptchaManager = new InterstitialCaptcha();
await interstitialCaptchaManager.submitCaptcha({ captcha: 'captchaValue' });

Paramètres de la méthode

Afficher Paramètres

options

SubmitCaptchaOptions.

captcha · string · requis

Le jeton de réponse du captcha.