Class OrganizationPicker

Class implementing the organization-picker screen functionality. This screen allows users to select an organization from a list of available organizations.

Hierarchy

BaseContext
- OrganizationPicker

Implements

OrganizationPickerMembers

Index

Constructors

constructor

new OrganizationPicker(): OrganizationPicker
Creates an instance of OrganizationPicker screen manager.

Returns OrganizationPicker
Overrides BaseContext.constructor
- Defined in src/screens/organization-picker/index.ts:16

Properties

branding

branding: BrandingMembers

client

client: ClientMembers

organization

organization: OrganizationMembers

prompt

prompt: PromptMembers

screen

screen: ScreenMembers

tenant

tenant: TenantMembers

transaction

transaction: TransactionMembers

untrustedData

untrustedData: UntrustedDataMembers

user

user: UserMembers

`Static`screenIdentifier

screenIdentifier: string = ''

Methods

selectOrganization

selectOrganization(payload): Promise<void>
Submits the selected organization ID.
Parameters
- payload: SelectOrganizationOptions
  The ID of the selected organization. { organization: string; }
Returns Promise<void>
Example
```
import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';

const organizationPicker = new OrganizationPicker();
organizationPicker.selectOrganization({
  organization: 'org_XXXXXXXXXXXXXXX'
});
```
Implementation of OrganizationPickerMembers.selectOrganization
- Defined in src/screens/organization-picker/index.ts:33

skipOrganizationSelection

skipOrganizationSelection(payload?): Promise<void>
Submits the action to skip the organization selection.
Parameters
- Optionalpayload: CustomOptions
  Optional custom options to include with the request.
Returns Promise<void>
Example
```
import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';

const organizationPicker = new OrganizationPicker();
organizationPicker.skipOrganizationSelection();
```
Implementation of OrganizationPickerMembers.skipOrganizationSelection
- Defined in src/screens/organization-picker/index.ts:52

Class OrganizationPicker

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns OrganizationPicker

Properties

branding

client

organization

prompt

screen

tenant

transaction

untrustedData

user

`Static`screenIdentifier

Methods

selectOrganization

Parameters

Returns Promise<void>

Example

skipOrganizationSelection

Parameters

Returns Promise<void>

Example

Settings

On This Page

Class OrganizationPicker

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns OrganizationPicker

Properties

branding

client

organization

prompt

screen

tenant

transaction

untrustedData

user

StaticscreenIdentifier

Methods

selectOrganization

Parameters

Returns Promise<void>

Example

skipOrganizationSelection

Parameters

Returns Promise<void>

Example

Settings

On This Page

`Static`screenIdentifier