SignupId - Auth0 Docs

The signup-id screen collects the user’s identifier — such as email, username, or phone number — as the first step of a multi-step signup flow. It also supports federated signup via social or enterprise connections.

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 { useSignupId } from '@auth0/auth0-acul-react';

// partial import
import {
  useSignupId,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
  useSignupIdentifiers,
  useUsernameValidation,
  // Methods
  signup,
  federatedSignup,
  pickCountryCode,
} from '@auth0/auth0-acul-react/signup-id';

function SignupIdForm() {
  const { signup } = useSignupId();
  return (
    <button onClick={() => signup({ email: 'user@example.com' })}>
      Continue
    </button>
  );
}

Context Hooks

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

() => BrandingMembers

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

Example

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

() => ClientMembers

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

Example

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

() => OrganizationMembers

This hook provides information about the user’s Organization if the signup is Organization scoped. Returns null when no Organization context is present.

Example

import { useOrganization } from '@auth0/auth0-acul-react/signup-id';
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/signup-id';
function FlowInfo() {
  const prompt = usePrompt();
}

() => ScreenMembersOnSignupId

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

Example

import { useScreen } from '@auth0/auth0-acul-react/signup-id';
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/signup-id';
function TenantInfo() {
  const tenant = useTenant();
}

() => TransactionMembersOnSignupId

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

Example

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

() => UntrustedDataMembers

This hook handles untrusted data passed to the screen, such as a prefilled email or username from URL parameters.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/signup-id';
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/signup-id';
function UserProfile() {
  const user = useUser();
}

This hook returns all methods and context available on the signup-id screen.

Methods

This method initiates signup via a federated identity provider, such as Google or GitHub.

Example

import { useSignupId } from '@auth0/auth0-acul-react/signup-id';

function SocialButton() {
  const { federatedSignup } = useSignupId();
  return (
    <button onClick={() => federatedSignup({ connection: 'google-oauth2' })}>
      Sign up with Google
    </button>
  );
}

Method Parameters

Show Parameters

FederatedSignupOptions.

string

required

The social or enterprise connection name to use (e.g. google-oauth2, github).

Promise<void>

This method opens the country code picker for phone number input during signup.

Example

import { useSignupId } from '@auth0/auth0-acul-react/signup-id';

function CountryCodePicker() {
  const { pickCountryCode } = useSignupId();
  return (
    <button onClick={() => pickCountryCode()}>
      Select Country Code
    </button>
  );
}

Method Parameters

Show Parameters

CustomOptions.

"string" | "number" | "boolean" | "undefined"

Additional custom fields prefixed with ulp- (for example, 'ulp-custom-field').

This method submits the user’s identifier to proceed to the next step of the signup flow.

Example

import { useSignupId } from '@auth0/auth0-acul-react/signup-id';

function SignupIdForm() {
  const { signup } = useSignupId();
  return (
    <button onClick={() => signup({ email: 'user@example.com' })}>
      Continue
    </button>
  );
}

Method Parameters

Show Parameters

SignupOptions.

string

The user’s email address.

string

The username for the new account, if required by the connection.

string

The user’s phone number, if required by the connection.

string

Captcha value required when bot detection is enabled on the tenant.

"string" | "number" | "boolean" | "undefined"

Additional custom fields prefixed with ulp- (for example, 'ulp-custom-field').

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.

Hooks

This hook returns the available signup identifier types (email, username, phone) configured for the connection.

Hooks

This hook validates the user’s username against the tenant’s username policy requirements.

​Import

​Context Hooks

​Methods

​Common/Utility Hooks

Import

Context Hooks

Methods

Common/Utility Hooks