Login

Import Example

import React, { useState } from "react";
import {
  useLogin,
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useUntrustedData,
} from "@auth0/auth0-acul-react/login";

Context Hooks

useBranding · () => BrandingMembers

Hook to access branding and theme configuration.

Example

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

useClient · () => ClientMembers

Hook to access Auth0 application (client) configuration.

Example

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

useOrganization · () => OrganizationMembers

Hook to access organization context and settings.

Example

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

usePrompt · () => PromptMembers

Hook to access prompt configuration and flow settings.

Example

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

useScreen · () => ScreenMembersOnLogin

Hook to access current screen information and metadata.

Screen object containing current screen name, configuration, and screen-specific data

Example

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

useTenant · () => TenantMembers

Hook to access tenant configuration and settings.

Example

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

useTransaction · () => TransactionMembersOnLogin

Hook to access transaction state and authentication flow data.

Transaction object containing flow state, session data, and transaction-specific information

Example

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

useUntrustedData · () => UntrustedDataMembers

Hook to access untrusted data from URL parameters and form submissions.

Example

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

useUser · () => UserMembers

Hook to access user information and profile data.

Example

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

Methods

federatedLogin · void | Promise<void>

Show Parameters

payload · FederatedLoginPayloadOptions

Properties

connection · string

The social connection name to use

login · void | Promise<void>

Show Parameters

payload · LoginPayloadOptions

Properties

captcha? · string

Optional captcha value if required

password · string

The password for authentication

username · string

The username/email to login with

pickCountryCode · void | Promise<void>

Show Parameters

payload · CustomOptions

useLogin · LoginMembers

Common/Utility Hooks

useLoginIdentifiers · Hooks

useCurrentScreen · Hooks

useErrors · Hooks

useAuth0Themes · Hooks

UseErrorOptions · Types

UseErrorsResult · Types

ErrorsResult · Types

ErrorKind · Types