Skip to content

Function: findUsersAndGroups() ​

ts
function findUsersAndGroups(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  groups?: {
   [key: string]: unknown;
     groups?: object[];
     header?: string;
     total?: number;
  };
  users?: {
   [key: string]: unknown;
     header?: string;
     total?: number;
     users?: object[];
  };
}>;

Defined in: src/server/api/groupAndUserPicker.ts:6

Returns a list of users and groups matching query with highlighting

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ fieldId?: string; issueTypeId?: string; maxResults?: string; projectId?: string; query?: string; showAvatar?: string; }-
parameters.fieldId?stringThe custom field id
parameters.issueTypeId?stringThe list of issue type ids to further restrict the search
parameters.maxResults?stringThe maximum number of users to return
parameters.projectId?stringThe list of project ids to further restrict the search
parameters.query?stringA string used to search username, Name or e-mail address
parameters.showAvatar?stringShow avatar
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; groups?: { [key: string]: unknown; groups?: object[]; header?: string; total?: number; }; users?: { [key: string]: unknown; header?: string; total?: number; users?: object[]; }; }>