This page is no longer maintained (29 Mar 2023). For the most current information, go to https://docs.snaplogic.com/public-apis/patch-groups-org-group.html.

`PATCH /groups/{org}/{groupname}`

Overview

This API adds or removes users from the specified group.

You need:

PATCH https://{pod_path}/api/1/rest/public/groups/{org}/{groupname}

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

org

Required. The name of the SnapLogic Org.

groupname

Required. The name of the group.

None.

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

Authorization: Basic {your_encoded_security_credentials}

Content-Type: application/json

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.

Status code only.