Skip to main content
The OrganizationPicker class implements the organization-picker screen functionality. This screen allows users to select an organization from a list of available organizations.

​
Constructors

Create an instance of OrganizationPicker screen manager
Example
import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';

const organizationPicker = new OrganizationPicker();
organizationPicker.selectOrganization({
  organization: 'org_XXXXXXXXXXXXXXX'
});

​
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-picker screen.
​
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 organization-picker 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-picker 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

​
selectOrganization
(options ?)
This method submits the selected organization ID.
Example
import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';

const organizationPicker = new OrganizationPicker();
organizationPicker.selectOrganization({
  organization: 'org_XXXXXXXXXXXXXXX'
});
​
options
OPTIONAL
Optional payload.
​
skipOrganizationSelection
(options ?)
This method submits the action to skip the organization selection.
Example
import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';

const organizationPicker = new OrganizationPicker();
organizationPicker.skipOrganizationSelection();
​
options
OPTIONAL
Optional payload.
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.