Create a group
POST /groups
Overview
This API creates a group.
To create the group and add its members,
- Verify that the target Environment/Org exists.
- Create the group using this API.
- 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://{pod_path}/api/1/rest/public/groups
Path Parameters
Key | Description |
---|---|
pod_path |
Required. The path to your SnapLogic pod.
Example: |
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.