Function: createGroup()

function createGroup(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;
  };
  id: string;
  managedBy?: "ADMINS" | "EXTERNAL" | "TEAM_MEMBERS" | "OPEN";
  name: string;
  resourceAri?: string;
  type: "group";
  usageType?: "USERBASE_GROUP" | "TEAM_COLLABORATION";
}>;

Defined in: src/v1/api/group.ts:40

Creates a new user group.

Permissions required: User must be a site admin.

Parameters

Parameter	Type
client	Client
parameters	{ name: string; }
parameters.name	string

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; }; id: string; managedBy?: "ADMINS" | "EXTERNAL" | "TEAM_MEMBERS" | "OPEN"; name: string; resourceAri?: string; type: "group"; usageType?: "USERBASE_GROUP" | "TEAM_COLLABORATION"; }>