Retrieve the list of groups in an Environment/Org

GET /groups/{env_org}

Overview

This API retrieves the list of groups in an Environment/Org.

Prerequisites

  • Environment (Org) admin permissions

Request

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

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.

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

None.

Response

Response Body

 {
  "groups": [ ... ]
}
Key Type Description
groups array An array of strings containing the names of the groups in the Environment/Org.