Skip to main content
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 logout = new Logout();

await logout.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.
​
organization
OrganizationMembers
Provides information about the user’s organization, such as organization 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

​
confirmLogout
(options ?)
This method confirms the logout action (accept or deny).
Example
import Logout from '@auth0/auth0-acul-js/logout';

const logout = new Logout();

await logout.confirmLogout({ action: 'accept' });
Method Parameters
​
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.