Organization screen classes

Organization Selection screen class

The Organization Selection screen class provides methods associated with the organization-selection screen.

Import and instantiate the Organization Selection screen class:

import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection';
const organizationSelection = new OrganizationSelection();

// SDK Properties return a string, number or boolean
// ex. "login-id"
organizationSelection.screen.name;

// SDK Methods return an object or array
await organizationSelection.continueWithOrganizationName({
  organizationName: 'testOrganizationName',
});

Properties

The Organization Selection screen class properties are:

branding

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

Methods

The Organization Selection screen class method is:

continueMfaSmsChallenge( options ?)

This method continues with the selected organization name.

import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection';
const organizationSelection = new OrganizationSelection();

await organizationSelection.continueWithOrganizationName({
  organizationName: 'testOrganizationName',
});

Parameter	Type	Required	Description
organizationName	string	Yes	The organization name.
[key: string]	string | number | boolean | undefined	No	Optional data collected from user.

Organization Picker screen class

The Organization Picker screen class provides methods associated with the organization-picker screen. This screen allows users to select an organization from a list of available organizations.

Import and instantiate the Organization Picker screen class:

import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';
const organizationPicker = new OrganizationPicker();

// SDK Properties return a string, number or boolean
// ex. "login-id"
organizationPicker.screen.name;

// SDK Methods return an object or array
organizationPicker.selectOrganization({
  organization: 'org_XXXXXXXXXXXXXXX'
});

Properties

The Organization Picker screen class properties are:

branding

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

Methods

The Organization Picker screen class method are:

continueEnrollment( options ?)

This method submits the selected organization ID.

import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';
const organizationPicker = new OrganizationPicker();

organizationPicker.selectOrganization({
  organization: 'org_XXXXXXXXXXXXXXX'
});

Parameter	Type	Required	Description
organization	string	Yes	The organization ID.
state	string	No

skipOrganizationSelection( options ?)

This method submits the action to skip the organization selection.

import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker';
const organizationPicker = new OrganizationPicker();

organizationPicker.skipOrganizationSelection();

Parameter	Type	Required	Description
[key: string]	string | number | boolean | undefined	No	Optional data collected from user.