Logout

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 de l’é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 paramètres liés à l’image de marque, comme le thème de l’image de marque et les paramètres.

client · ClientMembers

Fournit des paramètres liés au client, comme id, name et logoUrl, pour l’écran logout.

organization · OrganizationMembers

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

prompt · PromptMembers

Contient des données sur le prompt actuel dans le flux d’authentification.

screen · ScreenMembers

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

tenant · TenantMembers

Contient des données liées au tenant, 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

Gère les données non fiables transmises au SDK, comme les saisies de l’utilisateur pendant la connexion.

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 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 à 'session', la langue sélectionnée est enregistrée pour toute la durée de la session.

confirmLogout · Promise<void>

Cette méthode confirme l’action de logout (accepter ou rejeter).

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, à partir du contexte, le tableau des erreurs de transaction, ou un tableau vide s’il n’y en a aucune. Il s’agit d’un tableau d’objets d’erreur issus du contexte de la transaction.