Skip to content

Function: getCurrentUser() ​

ts
function getCurrentUser(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  accountId?: string;
  accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
  active?: boolean;
  applicationRoles?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     items?: object[];
     max-results?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  appType?: string;
  avatarUrls?: {
   [key: string]: unknown;
     16x16?: string;
     24x24?: string;
     32x32?: string;
     48x48?: string;
  };
  displayName?: string;
  emailAddress?: string;
  expand?: string;
  groups?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     items?: object[];
     max-results?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  guest?: boolean;
  locale?: string;
  self?: string;
  timeZone?: string;
}>;

Defined in: src/cloud/api/myself.ts:163

Returns details for the current user.

Permissions required: Permission to access Jira.

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ expand?: | "groups" | string & object | "applicationRoles" | ("groups" | string & object | "applicationRoles")[]; }-
parameters.expand?| "groups" | string & object | "applicationRoles" | ("groups" | string & object | "applicationRoles")[]Use expand to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include: - groups Returns all groups, including nested groups, the user belongs to. - applicationRoles Returns the application roles the user is assigned to.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; appType?: string; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }>