LoginPasswordlessEmailCode

Describes all the hooks and methods available to customize the Universal Login login-passwordless-email-code screen.

The login-passwordless-email-code screen prompts the user to enter a one-time code sent to their email address to complete passwordless authentication.

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

// partial import
import {
  useLoginPasswordlessEmailCode,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
  useResend,
  // Methods
  submitCode,
  resendCode,
  switchConnection,
} from '@auth0/auth0-acul-react/login-passwordless-email-code';

function EmailCodeForm() {
  const { submitCode } = useLoginPasswordlessEmailCode();
  return (
    <button onClick={() => submitCode({ code: '123456' })}>
      Verify Code
    </button>
  );
}

Context Hooks

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

useBranding · () => BrandingMembers

This hook provides branding configurations, such as logo, colors, and theme settings displayed on the login-passwordless-email-code screen.

Example

import { useBranding } from '@auth0/auth0-acul-react/login-passwordless-email-code';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

This hook provides client-related configurations, such as id, name, and logoUrl, for the login-passwordless-email-code screen.

Example

import { useClient } from '@auth0/auth0-acul-react/login-passwordless-email-code';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnLoginPasswordlessEmailCode

This hook contains details specific to the login-passwordless-email-code screen, including its configuration and context.

Example

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

useTransaction · () => TransactionMembersOnLoginPasswordlessEmailCode

This hook provides transaction-specific data for the login-passwordless-email-code screen, such as active connections and current flow state.

Example

import { useTransaction } from '@auth0/auth0-acul-react/login-passwordless-email-code';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useLoginPasswordlessEmailCode · LoginPasswordlessEmailCodeMembers

This hook returns all methods and context available on the login-passwordless-email-code screen.

Methods

resendCode · Promise<void>

This method resends the one-time code to the user’s email address.

Example

import { useLoginPasswordlessEmailCode } from '@auth0/auth0-acul-react/login-passwordless-email-code';

function ResendButton() {
  const { resendCode } = useLoginPasswordlessEmailCode();
  return (
    <button onClick={() => resendCode()}>
      Resend Code
    </button>
  );
}

Method Parameters

Show Parameters

options

CustomOptions.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

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

submitCode · Promise<void>

This method submits the one-time code to complete passwordless email authentication.

Example

import { useLoginPasswordlessEmailCode } from '@auth0/auth0-acul-react/login-passwordless-email-code';

function EmailCodeForm() {
  const { submitCode } = useLoginPasswordlessEmailCode();
  return (
    <button onClick={() => submitCode({ code: '123456' })}>
      Verify Code
    </button>
  );
}

Method Parameters

Show Parameters

options

SubmitCodeOptions.

code · string | number · required

The one-time code sent to the user’s email address.

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 to an alternate authentication connection without restarting the flow.

Example

import { useLoginPasswordlessEmailCode } from '@auth0/auth0-acul-react/login-passwordless-email-code';

function ConnectionSwitcher() {
  const { switchConnection } = useLoginPasswordlessEmailCode();
  return (
    <button onClick={() => switchConnection({ connection: 'enterprise-saml' })}>
      Use SSO
    </button>
  );
}

Method Parameters

Show Parameters

options

SwitchConnectionOptionsEmailCode.

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.

useResend · Hooks

This hook manages resend cooldown state and availability for code resend actions.