Cierre de sesión

Describe todas las propiedades y los métodos disponibles para personalizar la pantalla logout de Universal Login.

La clase Logout implementa la funcionalidad de la pantalla logout. Esta pantalla permite a los usuarios confirmar o rechazar la acción de cierre de sesión.

​

Constructores

Cree una instancia del administrador de la pantalla de cierre de sesión:

Example

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

​

Propiedades

branding · BrandingMembers

Proporciona configuraciones relacionadas con la marca, como el tema y sus ajustes.

client · ClientMembers

Proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla logout.

organization · OrganizationMembers

Proporciona información sobre la organización del usuario, como id y name.

prompt · PromptMembers

Contiene datos sobre la pantalla actual del flujo de autenticación.

screen · ScreenMembers

Contiene detalles específicos de la pantalla logout, incluida su configuración y contexto.

tenant · TenantMembers

Contiene datos relacionados con el inquilino, como id y los metadatos asociados.

transaction · TransactionMembers

Proporciona datos específicos de la transacción, como identificadores activos y estados del flujo.

untrustedData · UntrustedDataMembers

Contiene datos no confiables enviados al SDK, como la entrada del usuario durante el inicio de sesión.

user · UserMembers

Contiene detalles del usuario activo, incluidos username, email y roles.

​

Métodos

changeLanguage · Promise<void>

Este método cambia el idioma de visualización de la página de Universal Login.

Example

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

Parámetros del método

Mostrar Parámetros

options

LanguageChangeOptions.

language · string · requerido

El código de configuración regional del idioma deseado (por ejemplo, 'en', 'fr', 'es').

persist? · "session"

Si se establece en 'session', el idioma seleccionado se mantiene durante toda la sesión.

confirmLogout · Promise<void>

Este método confirma la acción de cierre de sesión (aceptarla o rechazarla).

Example

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

Parámetros del método

Mostrar Parámetros

options

ConfirmLogoutOptions.

action · "accept" | "deny" · requerido

El estado de la transacción de autenticación.

getErrors · Error []

Este método recupera el array de errores de la transacción desde el contexto, o un array vacío si no hay ninguno. Devuelve un array de objetos de error del contexto de la transacción.