SignupPassword - Auth0 Docs

The signup-password screen collects the user’s password to complete account creation. It is the second step of a multi-step signup flow, following identifier collection. 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 { useSignupPassword } from '@auth0/auth0-acul-react';

// partial import
import {
  useSignupPassword,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
  usePasswordValidation,
  // Methods
  signup,
  federatedSignup,
  switchConnection,
} from '@auth0/auth0-acul-react/signup-password';

function SignupPasswordForm() {
  const { signup } = useSignupPassword();
  return (
    <button onClick={() => signup({ password: 'secret' })}>
      Create Account
    </button>
  );
}

Context Hooks

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

useBranding

() => BrandingMembers

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

Example

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

useClient

() => ClientMembers

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

Example

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

useOrganization

() => 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-password';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}

usePrompt

() => PromptMembers

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

Example

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

useScreen

() => ScreenMembersOnSignupPassword

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

Example

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

useTenant

() => TenantMembers

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

Example

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

useTransaction

() => TransactionMembersOnSignupPassword

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

Example

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

useUntrustedData

() => 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-password';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser

() => 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-password';
function UserProfile() {
  const user = useUser();
}

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

Methods

This method redirects the user to the Social or Enterprise Identity Provider (IdP) for signup.

Example

import { useSignupPassword } from '@auth0/auth0-acul-react/signup-password';

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

Method Parameters

Show Parameters

options

FederatedSignupPasswordPayloadOptions.

connection

string

required

The Social or Enterprise Identity Provider connection name.

This method submits the user’s password to complete account creation.

Example

import { useSignupPassword } from '@auth0/auth0-acul-react/signup-password';

function SignupPasswordForm() {
  const { signup } = useSignupPassword();
  return (
    <button onClick={() => signup({ password: 'secret' })}>
      Create Account
    </button>
  );
}

Method Parameters

Show Parameters

options

SignupPasswordOptions.

password

string

required

The password for the new account.

string

The user’s email address.

username

string

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

phoneNumber

string

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

captcha?

string

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

[`key`: `string`]

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

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

switchConnection

Promise<void>

This method switches the active connection during the signup-password step, allowing the user to authenticate via a different connection.

Example

import { useSignupPassword } from '@auth0/auth0-acul-react/signup-password';

function SwitchConnection() {
  const { switchConnection } = useSignupPassword();
  return (
    <button onClick={() => switchConnection({ connection: 'Username-Password-Authentication' })}>
      Use a different method
    </button>
  );
}

Method Parameters

Show Parameters

options

SwitchConnectionOptionsSignupPassword.

connection

string

required

The connection name to switch to. Use ‘email’ or ‘sms’ for passwordless, or a DB connection name for password-based authentication.

[`key`: `string`]

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

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

Common/Utility Hooks

useAuth0Themes

Hooks

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

useChangeLanguage

Hooks

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

useCurrentScreen

Hooks

This hook gets the current screen context and state.

useErrors

Hooks

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

usePasswordValidation

Hooks

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

​Import

​Context Hooks

​Methods

​Common/Utility Hooks

Import

Context Hooks

Methods

Common/Utility Hooks