Function: createGroup()

function createGroup(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  expand?: string;
  groupId?: string | null;
  name?: string;
  self?: string;
  users?: {
   [key: string]: unknown;
     end-index?: number;
     items?: object[];
     max-results?: number;
     size?: number;
     start-index?: number;
  };
}>;

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

Creates a group.

Permissions required: Site administration (that is, member of the site-admin group).

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ name: string; }	-
parameters.name	string	The name of the group.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; expand?: string; groupId?: string | null; name?: string; self?: string; users?: { [key: string]: unknown; end-index?: number; items?: object[]; max-results?: number; size?: number; start-index?: number; }; }>