Skip to main content
ACUL 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
Hook to access branding and theme configuration.
Example
import { useBranding } from '@auth0/auth0-acul-react/login-id';
function CustomTheme() {
  const branding = useBranding();
}
useClient
Hook to access Auth0 application (client) configuration.
Example
import { useClient } from '@auth0/auth0-acul-react/login-id';
function AppInfo() {
  const client = useClient();
}
useOrganization
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
Hook to access prompt configuration and flow settings.
Example
import { usePrompt } from '@auth0/auth0-acul-react/login-id';
function FlowInfo() {
  const prompt = usePrompt();
}
useScreen
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
Hook to access tenant configuration and settings.
Example
import { useTenant } from '@auth0/auth0-acul-react/login-id';
function TenantInfo() {
  const tenant = useTenant();
}
useTransaction
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
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
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
login
pickCountryCode
useLogin

Common/Utility Hooks