Function: getGroupMembershipsForUser()

function getGroupMembershipsForUser(client, parameters): Promise<{
[key: string]: unknown;
  _links: {
   [key: string]: unknown;
     base?: string;
     byOperation?: string;
     collection?: string;
     context?: string;
     download?: string;
     editui?: string;
     edituiv2?: string;
     next?: string;
     prev?: string;
     self?: string;
     tinyui?: string;
     webui?: string;
  };
  limit: number;
  results: object[];
  size: number;
  start: number;
  totalSize?: number;
}>;

Defined in: src/v1/api/users.ts:85

Returns the groups that a user is a member of.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ accountId: string; limit?: number; start?: number; }	-
parameters.accountId	string	The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
parameters.limit?	number	The maximum number of groups to return per page. Note, this may be restricted by fixed system limits.
parameters.start?	number	The starting index of the returned groups.

Returns

Promise<{ [key: string]: unknown; _links: { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; }; limit: number; results: object[]; size: number; start: number; totalSize?: number; }>