Skip to main content

Type Alias: UserContext

type UserContext = {
  client: ServiceContextState["client"];
  isUserContext: true;
  tokenFingerprint?: string;
  userEmail?: string;
  userId: string;
  userName?: string;
  warehouseId?: Promise<string>;
  workspaceId: Promise<string>;
};

Deprecated

Use CallerContext and its principal field. Kept for callers that construct the legacy shape or read its flat identity fields.

Properties

client

client: ServiceContextState["client"];

WorkspaceClient authenticated as the user


isUserContext

isUserContext: true;

Flag indicating this is a user context


tokenFingerprint?

optional tokenFingerprint: string;

Truncated SHA-256 hash of the user's OBO token, used to detect token rotation


userEmail?

optional userEmail: string;

The user's email (from x-forwarded-email header)


userId

userId: string;

The user's ID (from request headers)


userName?

optional userName: string;

The user's name (from request headers)


warehouseId?

optional warehouseId: Promise<string>;

Deprecated

Use getWarehouseId() from @databricks/appkit.


workspaceId

workspaceId: Promise<string>;

Promise that resolves to the workspace ID (inherited from service context)

Databricks Developer Hub

Ready to ship your next agentic app in minutes?

Read docs