> ## Documentation Index
> Fetch the complete documentation index at: https://docs-dev-docs-event-stream-action-templates.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

<Frame>
  <img style={{maxHeight:"400px"}} src="https://mintcdn.com/docs-dev-docs-event-stream-action-templates/DJz3781nwG6wS-wJ/docs/images/cdy7uua7fh8z/4fvafgoqxrpjSNPdR8tlGj/185beaff20e8fe2b23a4ca3810940fe9/Screenshot_2025-05-15_at_16.04.46.png?fit=max&auto=format&n=DJz3781nwG6wS-wJ&q=85&s=89eff06a6805fdd960e26d5b8065b608" alt="" width="391" height="527" data-path="docs/images/cdy7uua7fh8z/4fvafgoqxrpjSNPdR8tlGj/185beaff20e8fe2b23a4ca3810940fe9/Screenshot_2025-05-15_at_16.04.46.png" />
</Frame>

## Constructors

Create an instance of the Logout screen manager:

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

## Properties

<ParamField body="branding" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}>
  Provides branding-related configurations, such as branding theme and settings.
</ParamField>

<ParamField body="client" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}>
  Provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `logout` screen.
</ParamField>

<ParamField body="organization" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}>
  Provides information about the user's Organization, such as `id` and `name`.
</ParamField>

<ParamField body="prompt" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}>
  Contains data about the current prompt in the authentication flow.
</ParamField>

<ParamField body="screen" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}>
  Contains details specific to the `logout` screen, including its configuration and context.
</ParamField>

<ParamField body="tenant" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}>
  Contains data related to the tenant, such as `id` and associated metadata.
</ParamField>

<ParamField body="transaction" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}>
  Provides transaction-specific data, such as active identifiers and flow states.
</ParamField>

<ParamField body="untrustedData" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}>
  Handles untrusted data passed to the SDK, such as user input during login.
</ParamField>

<ParamField body="user" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}>
  Details of the active user, including `username`, `email`, and `roles`.
</ParamField>

## Methods

<ParamField body="changeLanguage" type="Promise<void>">
  This method changes the display language of the Universal Login page.

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

  **Method Parameters**

  <Expandable title="Parameters">
    <ParamField body="options">
      [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions).
    </ParamField>

    <ParamField body="language" type="string" required>
      The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
    </ParamField>

    <ParamField body="persist?" type="&#x22;session&#x22;">
      When set to `'session'`, the selected language persists for the duration of the session.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="confirmLogout" type="Promise<void>">
  This method confirms the logout action (accept or deny).

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

  **Method Parameters**

  <Expandable title="Parameters">
    <ParamField body="options">
      [ConfirmLogoutOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/ConfirmLogoutOptions).
    </ParamField>

    <ParamField body="action" type="&#x22;accept&#x22; | &#x22;deny&#x22;" required>
      The authentication transaction state.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="getErrors" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>
  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.
</ParamField>
