CurrentScreenOptions

Options object describing the current screen context in an Auth0 Universal Login flow. Provides access to client, organization, tenant, transaction, and screen metadata available at runtime.

Example

export interface CurrentScreenOptions {
  client: {
    id: string;
    metadata: Record<string, string> | null;
  } | null;
  organization: {
    id: string;
    metadata: Record<string, string> | null;
  } | null;
  prompt: {
    name: string;
  } | null;
  screen: {
    name: string;
  } | null;
  tenant: {
    enabledLocales: string[];
  } | null;
  transaction: {
    errors: TransactionError[] | null;
    state: string;
    locale: string;
  } | null;
  untrustedData: {
    authorizationParams: Record<string, string> | null;
  } | null;
}

Properties

client · { id: string; metadata: Record<string, string> | null } | null

Client details for the current authorization request, including the client identifier and any associated metadata.

organization · { id: string; metadata: Record<string, string> | null } | null

Organization context for the current request, including the organization identifier and metadata.

prompt · { name: string } | null

The current prompt configuration, identifying which prompt step is being rendered.

screen · { name: string } | null

The current screen configuration, identifying which screen within the prompt is active.

tenant · { enabledLocales: string[] } | null

Tenant-level settings, including the list of locales enabled for this Universal Login deployment.

transaction · { errors: TransactionError[] | null; state: string; locale: string } | null

Transaction state for the current authentication flow, including any validation errors, the state identifier, and the active locale.

untrustedData · { authorizationParams: Record<string, string> | null } | null

Untrusted data passed into the flow, such as authorization parameters that should not be relied upon for security decisions.