RedeemTicket - Auth0 Docs

The redeem-ticket screen is displayed when a user needs to redeem a ticket to continue the authentication flow, such as during invitation acceptance or email verification.

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

// partial import
import {
  useRedeemTicket,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
  // Methods
  continueMethod,
} from '@auth0/auth0-acul-react/redeem-ticket';

function RedeemTicketScreen() {
  const { continueMethod } = useRedeemTicket();
  return (
    <button onClick={() => continueMethod()}>Continue</button>
  );
}

Context Hooks

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

() => BrandingMembers

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

Example

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

() => ClientMembers

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

Example

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

() => OrganizationMembers

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

Example

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

() => PromptMembers

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

Example

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

() => ScreenMembers

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

Example

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

() => TenantMembers

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

Example

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

() => TransactionMembers

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

Example

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

() => UntrustedDataMembers

This hook handles untrusted data passed to the screen, such as prefilled parameters from URL query strings.

Example

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

() => UserMembers

This hook provides details of the active user, including username, email, and available authentication methods.

Example

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

RedeemTicketMembers

This hook returns all methods and context available on the redeem-ticket screen.

Methods

Promise<void>

This method performs the default action on the redeem-ticket screen, continuing the authentication flow after the ticket has been redeemed.

Example

import { useRedeemTicket } from '@auth0/auth0-acul-react/redeem-ticket';

function ContinueButton() {
  const { continueMethod } = useRedeemTicket();
  return (
    <button onClick={() => continueMethod()}>
      Continue
    </button>
  );
}

Common/Utility Hooks

Hooks

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

Hooks

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

Hooks

This hook gets the current screen context and state.

Hooks

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

​Import

​Context Hooks

​Methods

​Common/Utility Hooks

Import

Context Hooks

Methods

Common/Utility Hooks