OrganizationSelection

Describes all the properties and methods available to customize the Universal Login organization-selection screen.

The OrganizationSelection class implements the organization-selection screen functionality. This screen allows users to select an organization to continue with.

Constructors

Create an instance of OrganizationSelection screen manager:

Example

import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection';
const organizationSelectionManager = new OrganizationSelection();
await organizationSelectionManager.continueWithOrganizationName({
  organizationName: 'testOrganizationName',
});

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 organization-selection 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 · ScreenMembersOnOrganizationSelection

Contains details specific to the organization-selection 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 for the organization-selection screen, such as active identifiers and flow states.

untrustedData · UntrustedDataMembers

Handles untrusted data passed to the SDK, such as user input during the organization selection flow.

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 OrganizationSelection from '@auth0/auth0-acul-js/organization-selection';
const organizationSelectionManager = new OrganizationSelection();
organizationSelectionManager.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.

continueWithOrganizationName · Promise<void>

This method continues with the selected organization name.

Example

import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection';
const organizationSelectionManager = new OrganizationSelection();
await organizationSelectionManager.continueWithOrganizationName({
  organizationName: 'testOrganizationName',
});

Method Parameters

Show Parameters

options

ContinueWithOrganizationNameOptions.

organizationName · string · required

The name of the organization to continue with.

getErrors · Error []

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