Function: currentUser()

function currentUser(client, options?): Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationRoles?: {
   [key: string]: unknown;
     items?: Record<string, any>[];
     size?: number;
  };
  avatarUrls?: Record<string, string>;
  deleted?: boolean;
  displayName?: string;
  emailAddress?: string;
  expand?: string;
  groups?: {
   [key: string]: unknown;
     items?: Record<string, any>[];
     size?: number;
  };
  key?: string;
  locale?: string;
  name?: string;
  self?: string;
  timeZone?: string;
}>;

Defined in: src/server/api/session.ts:10

Returns information about the currently authenticated user's session. If the caller is not authenticated they will get a 401 Unauthorized status code.

Parameters

Parameter	Type
client	Client
options?	RequestOptions

Returns

Promise<{ [key: string]: unknown; active?: boolean; applicationRoles?: { [key: string]: unknown; items?: Record<string, any>[]; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; items?: Record<string, any>[]; size?: number; }; key?: string; locale?: string; name?: string; self?: string; timeZone?: string; }>