Skip to content

Function: createGroup() ​

ts
function createGroup(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/admin/api/groups.ts:312

Create a group in a directory to manage app access and permissions for multiple users together.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ description?: string; directoryId: string; name: string; orgId: string; }-
parameters.description?stringDescribe what the group is or what it might be used for.
parameters.directoryId?stringA directory has a unique ID. Use the Get directories endpoint to find the directory ID.
parameters.name?stringName the group.
parameters.orgId?stringYour organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?RequestOptions-

Returns ​

Promise<void>