Déconnexion

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

La classe Logout implémente la fonctionnalité de l’écran logout. Cet écran permet aux utilisateurs de confirmer ou d’annuler la déconnexion.

​

Constructeurs

Créez une instance du gestionnaire d’écran Logout :

Example

import Logout from '@auth0/auth0-acul-js/logout';
const logoutManager = new Logout();
logoutManager.confirmLogout({
  action: 'accept',
});

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

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

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 du flux d’authentification.

screen · ScreenMembers

Contient des détails propres à l’écran logout, notamment 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, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Contient des données non fiables transmises au SDK, comme les entrées de l’utilisateur pendant la connexion.

user · UserMembers

Contient des détails sur l’utilisateur actif, notamment username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

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

Example

import Logout from '@auth0/auth0-acul-js/logout';
const logoutManager = new Logout();
logoutManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

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

persist? · "session"

Lorsqu’elle est définie sur 'session', la langue sélectionnée est conservée pendant toute la session.

confirmLogout · Promise<void>

Cette méthode confirme l’action de déconnexion (accepter ou refuser).

Example

import Logout from '@auth0/auth0-acul-js/logout';
const logoutManager = new Logout();
logoutManager.confirmLogout({
  action: 'accept',
});

Paramètres de la méthode

Afficher Paramètres

options

ConfirmLogoutOptions.

action · "accept" | "deny" · requis

L’état de la transaction d’authentification.

getErrors · Error []

Cette méthode récupère le tableau des erreurs de la transaction à partir du contexte, ou un tableau vide s’il n’y en a aucune. Elle renvoie un tableau d’objets d’erreur provenant du contexte de la transaction.