Function: getUsersFromGroup()

function getUsersFromGroup(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;

Defined in: src/cloud/api/groups.ts:67

Returns a paginated list of all users in a group.

Note that users are ordered by username, however the username is not returned in the results due to privacy reasons.

Permissions required: either of:

• Browse users and groups global permission.
• Administer Jira global permission.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ groupId?: string; groupname?: string; includeInactiveUsers?: boolean; maxResults?: number; startAt?: number; }	-
parameters.groupId?	string	The ID of the group. This parameter cannot be used with the groupName parameter.
parameters.groupname?	string	As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter.
parameters.includeInactiveUsers?	boolean	Include inactive users.
parameters.maxResults?	number	The maximum number of items to return per page (number should be between 1 and 50).
parameters.startAt?	number	The index of the first item to return in a page of results (page offset).
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>