OrganizationPicker

The organization-picker screen is displayed when a user needs to select an organization to log in to. It allows the user to choose an organization or skip the selection step.

Import

Each screen has its own set of hooks and methods. The SDK supports partial import and root import for each screen.

Using partial import allows you to include only the code you need for your specific use case.
Using root import allows you to load all screens from a single bundle, which is useful when you want a unified build to handle all possible screens.

Import Example

// root import
import { useOrganizationPicker } from '@auth0/auth0-acul-react';

// partial import
import {
  useOrganizationPicker,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
  // Methods
  selectOrganization,
  skipOrganizationSelection,
} from '@auth0/auth0-acul-react/organization-picker';

function OrganizationPickerScreen() {
  const { selectOrganization } = useOrganizationPicker();
  return (
    <button onClick={() => selectOrganization({ organization: 'my-org', state: 'abc123' })}>Select</button>
  );
}

Context Hooks

Screen-scoped hooks that provide read-only access to Auth0 context data on the organization-picker screen. Import them from @auth0/auth0-acul-react/organization-picker.

() => BrandingMembers

This hook provides branding configurations, such as logo, colors, and theme settings displayed on the organization-picker screen.

Example

import { useBranding } from '@auth0/auth0-acul-react/organization-picker';
function CustomTheme() {
  const branding = useBranding();
}

() => ClientMembers

This hook provides client-related configurations, such as id, name, and logoUrl, for the organization-picker screen.

Example

import { useClient } from '@auth0/auth0-acul-react/organization-picker';
function AppInfo() {
  const client = useClient();
}

() => OrganizationMembers

This hook provides information about the user’s Organization context on the organization-picker screen. Returns null when no Organization context is present.

Example

import { useOrganization } from '@auth0/auth0-acul-react/organization-picker';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}

() => PromptMembers

This hook contains data about the current prompt in the authentication flow.

Example

import { usePrompt } from '@auth0/auth0-acul-react/organization-picker';
function FlowInfo() {
  const prompt = usePrompt();
}

() => ScreenMembers

This hook contains details specific to the organization-picker screen, including its configuration and context.

Example

import { useScreen } from '@auth0/auth0-acul-react/organization-picker';
function ScreenDebug() {
  const screen = useScreen();
}

() => TenantMembers

This hook contains data related to the tenant, such as id and associated metadata.

Example

import { useTenant } from '@auth0/auth0-acul-react/organization-picker';
function TenantInfo() {
  const tenant = useTenant();
}

() => TransactionMembers

This hook provides transaction-specific data for the organization-picker screen, such as active connections and current flow state.

Example

import { useTransaction } from '@auth0/auth0-acul-react/organization-picker';
function TransactionInfo() {
  const transaction = useTransaction();
}

() => UntrustedDataMembers

This hook handles untrusted data passed to the screen, such as prefilled parameters from URL query strings.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/organization-picker';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

() => UserMembers

This hook provides details of the active user, including username, email, and available authentication methods.

Example

import { useUser } from '@auth0/auth0-acul-react/organization-picker';
function UserProfile() {
  const user = useUser();
}

OrganizationPickerMembers

This hook returns all methods and context available on the organization-picker screen.

Methods

Promise<void>

This method submits the user’s Organization selection and continues the authentication flow.

Example

import { useOrganizationPicker } from '@auth0/auth0-acul-react/organization-picker';

function SelectButton() {
  const { selectOrganization } = useOrganizationPicker();
  return (
    <button onClick={() => selectOrganization({ organization: 'my-org', state: 'abc123' })}>
      Select Organization
    </button>
  );
}

Method Parameters

Show Parameters

SelectOrganizationOptions.

string

required

The Organization identifier selected by the user.

string

required

The current authentication state value.

Promise<void>

This method allows the user to skip the Organization selection step and continue the authentication flow without selecting an Organization.

Example

import { useOrganizationPicker } from '@auth0/auth0-acul-react/organization-picker';

function SkipButton() {
  const { skipOrganizationSelection } = useOrganizationPicker();
  return (
    <button onClick={() => skipOrganizationSelection()}>
      Skip
    </button>
  );
}

Common/Utility Hooks

Hooks

This hook gets the current theme options with flattened configuration from branding context.

Hooks

This hook returns a function for changing the display language on the current ACUL screen.

Hooks

This hook gets the current screen context and state.

Hooks

This hook reads and manages server, client, and developer errors on the screen.

auth0-php

auth0-acul-js

auth0-acul-react

Import

Context Hooks

Methods

Common/Utility Hooks

​Import

​Context Hooks

​Methods

​Common/Utility Hooks

Import

Context Hooks

Methods

Common/Utility Hooks