Logout

Describes all the properties and methods available to customize the Universal Login Logout screen.

The Logout class implements the logout screen functionality. This screen allows users to confirm or deny the logout action.

Constructors

Create an instance of the Logout screen manager:

Example

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

Properties

branding · BrandingMembers

Provides branding-related configurations, such as branding theme and settings.

client · ClientMembers

Provides client-related configurations, such as id, name, and logoUrl, for the logout screen.

organization · OrganizationMembers

Provides information about the user’s Organization, such as id and name.

prompt · PromptMembers

Contains data about the current prompt in the authentication flow.

screen · ScreenMembers

Contains details specific to the logout screen, including its configuration and context.

tenant · TenantMembers

Contains data related to the tenant, such as id and associated metadata.

transaction · TransactionMembers

Provides transaction-specific data, such as active identifiers and flow states.

untrustedData · UntrustedDataMembers

Handles untrusted data passed to the SDK, such as user input during login.

user · UserMembers

Details of the active user, including username, email, and roles.

Methods

changeLanguage · Promise<void>

This method changes the display language of the Universal Login page.

Example

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

Method Parameters

Show Parameters

options · LanguageChangeOptions

language · string · required

The locale code for the desired language (for example, 'en', 'fr', 'es').

persist? · "session"

When set to 'session', the selected language persists for the duration of the session.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Additional custom fields prefixed with ulp- (for example, 'ulp-custom-field').

---

confirmLogout · Promise<void>

This method confirms the logout action (accept or deny).

Example

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

Method Parameters

Show Parameters

options · ConfirmLogoutOptions

action · "accept" | "deny" · required

The authentication transaction state.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Additional data collected from the user.

---

getErrors · Error []

This method retrieves the array of transaction errors from the context, or an empty array if none exist. An array of error objects from the transaction context.