Retrieve info about a group

GET /groups/{env_org}/{groupname}

Overview

This API retrieves information about the specified group.

Prerequisites

  • Org admin (Environment admin) permissions

Request

 GET 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: control-plane-name.snaplogic.com

Where control-plane-name is the control plane you are using. For example,
  • elastic
  • uat
  • emea
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

None.

Response

Response Body

 {
  "name": "...",
  "members": [ ... ]
}
Key Type Description
name string The name of the group.
members array An array of strings containing the usernames or email addresses of the group members.