Add or remove users from a group

PATCH /groups/{env_org}/{groupname}

Overview

This API adds or removes users from the specified group.

Prerequisites

  • Environment (Org) admin permissions

Request

 PATCH https://{controlplane_path}/api/1/rest/public/groups/{env_org}/{groupname}

Path Parameters

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

Example: cdn.elastic.snaplogic.com

For other control planes, substitute the subdomain name for elastic. For example:
  • cdn.uat.snaplogic.com
  • cdn.emea.snaplogic.com
org Required. The name of the SnapLogic Environment/Org.
groupname Required. The name of the group.

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

Important: Only one of the following parameters can be used in each API call.
 {
  "add_user" : "..."
}

 {
  "remove_user" : "..."
}
Key Type Description
add_user string The email address of the user to add to the group.
remove_user string The email address of the user to remove from the group.