Create a group or add members

POST https://{controlplane_path}/api/1/rest/public/groups

Creates a group or adds members in the specified environment (organization). Environment admins can also create and manage groups from the Admin Manager Groups page.

To create the group and add members with the groups endpoint:

  1. Verify that the target environment (Org) exists.
  2. Create the group.
  3. Add the members to the group.
Important: Avoid space characters for a group name. Underscores are acceptable.

Prerequisites

  • Environment (Org) admin permissions

Query parameters

None.

Request body

 {
  "organization" : "...",
  "name" : "...",
  "members" : [ ... ]
}
Key Type Description
organization string The Environment/Org to create the group in.
name string Required. The name of the group.
members array An array of strings containing email addresses of users to add to the group.

Response

Status code only.