Create a group

POST /groups

Overview

This API creates a group.

To create the group and add its members,
  1. Verify that the target Environment/Org exists.
  2. Create the group using this API.
  3. Add the members to the group using this API.
Important: Avoid space characters in your Group name; instead, use underscores.

Prerequisites

  • Org admin (Environment admin) permissions

Request

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

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic control plane.

Example: control-plane-name.snaplogic.com

Where control-plane-name is the control plane you are using. For example,
  • elastic
  • uat
  • emea

Query Parameters

None.

Request Header

Specify Basic for authorization and application/json for content type.

 Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

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.