Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0-feat-ionic-capacitor-quickstart-modernization.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The login-password screen collects the user’s password as the second step of an identifier-first authentication flow. It also supports switching to a federated identity provider or an alternate connection.

​
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 useful when you want a unified build to handle all possible screens.
Import Example
// root import
import { useLoginPassword } from '@auth0/auth0-acul-react';

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

function LoginPasswordForm() {
  const { login } = useLoginPassword();
  return (
    <button onClick={() => login({ username: 'user@example.com', password: 'secret' })}>
      Sign In
    </button>
  );
}

​
Context Hooks

Screen-scoped hooks that provide read-only access to Auth0 context data on the login-password screen. Import them from @auth0/auth0-acul-react/login-password.
​
useBranding
() => BrandingMembers
Provides branding configurations, such as logo, colors, and theme settings displayed on the login-password screen.
Example
import { useBranding } from '@auth0/auth0-acul-react/login-password';
function CustomTheme() {
  const branding = useBranding();
}
​
useClient
() => ClientMembers
Provides client-related configurations, such as id, name, and logoUrl, for the login-password screen.
Example
import { useClient } from '@auth0/auth0-acul-react/login-password';
function AppInfo() {
  const client = useClient();
}
​
useOrganization
() => OrganizationMembers
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-password';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}
​
usePrompt
() => PromptMembers
Contains data about the current prompt in the authentication flow.
Example
import { usePrompt } from '@auth0/auth0-acul-react/login-password';
function FlowInfo() {
  const prompt = usePrompt();
}
​
useScreen
() => ScreenMembersOnLoginPassword
Contains details specific to the login-password screen, including its configuration and context.
Example
import { useScreen } from '@auth0/auth0-acul-react/login-password';
function ScreenDebug() {
  const screen = useScreen();
}
​
useTenant
() => TenantMembers
Contains data related to the tenant, such as id and associated metadata.
Example
import { useTenant } from '@auth0/auth0-acul-react/login-password';
function TenantInfo() {
  const tenant = useTenant();
}
​
useTransaction
() => TransactionMembersOnLoginPassword
Provides transaction-specific data for the login-password screen, such as active connections and current flow state.
Example
import { useTransaction } from '@auth0/auth0-acul-react/login-password';
function TransactionInfo() {
  const transaction = useTransaction();
}
​
useUntrustedData
() => UntrustedDataMembers
Handles untrusted data passed to the screen, such as a prefilled identifier from URL parameters.
Example
import { useUntrustedData } from '@auth0/auth0-acul-react/login-password';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}
​
useUser
() => UserMembers
Details of the active user, including username, email, and available authentication methods.
Example
import { useUser } from '@auth0/auth0-acul-react/login-password';
function UserProfile() {
  const user = useUser();
}

​
Methods

​
federatedLogin
void | Promise<void>
Initiates authentication via a federated identity provider such as Google or GitHub.
Example
import { useLoginPassword } from '@auth0/auth0-acul-react/login-password';

function SocialButton() {
  const { federatedLogin } = useLoginPassword();
  return (
    <button onClick={() => federatedLogin({ connection: 'google-oauth2' })}>
      Sign in with Google
    </button>
  );
}
​
login
void | Promise<void>
Submits the user’s credentials to complete authentication on the login-password screen.
Example
import { useLoginPassword } from '@auth0/auth0-acul-react/login-password';

function LoginPasswordForm() {
  const { login } = useLoginPassword();
  return (
    <button onClick={() => login({ username: 'user@example.com', password: 'secret' })}>
      Sign In
    </button>
  );
}
​
switchConnection
void | Promise<void>
Switches to an alternate authentication connection without restarting the flow.
Example
import { useLoginPassword } from '@auth0/auth0-acul-react/login-password';

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

​
Common/Utility Hooks

​
useAuth0Themes
Hooks
Get the current theme options with flattened configuration from branding context.
​
useChangeLanguage
Hooks
Returns a function for changing the display language on the current ACUL screen.
​
useCurrentScreen
Hooks
Gets the current screen context and state.
​
useErrors
Hooks
Read and manage server, client, and developer errors on the screen.