GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups

Gets the list of groups on a given GSM site.

Request Information

URI Parameters

Name	Description	Type	Additional Information
gsmKey	The GSM console keycode.	string	Required
siteId	The site identifier.	string	Required

URI Sample(s)


GET	https://unityapi.webrootcloudav.com/service/api/console/gsm/D38B-C725-00A7-41AB-B023/sites/6756b451-e12e-464d-8a05-24a118530da1/groups

Body Parameters

None.

Response Information

Resource Description

Information about the list of groups on a given GSM site.

GetGroupsResponseModel

Name	Description	Type	Additional Information
TotalCount	Total number of groups available.	integer	None.
Groups	List of group details records.	Collection of GetGroupsResponseModel_Group	None.

Sample Response

{
  "TotalCount": 2,
  "Groups": [
    {
      "Endpoints": 66,
      "GroupCode": "-729447649",
      "GroupId": "e38d5115-8a25-4867-a7c7-9c41ff19cab9",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "f9f586b9-f8cc-47e7-927d-12fe74c6707b",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 76,
      "GroupCode": "-189866282",
      "GroupId": "8092c91e-4c2a-44e8-86fb-de236c22bdff",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "f0a3d1db-799b-4dec-b631-296008658ed2",
      "GroupPolicyName": "Test Policy 2"
    }
  ]
}

<GetGroupsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <Groups>
    <GetGroupsResponseModel_Group>
      <Endpoints>66</Endpoints>
      <GroupCode>-729447649</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>e38d5115-8a25-4867-a7c7-9c41ff19cab9</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>f9f586b9-f8cc-47e7-927d-12fe74c6707b</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>76</Endpoints>
      <GroupCode>-189866282</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>8092c91e-4c2a-44e8-86fb-de236c22bdff</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>f0a3d1db-799b-4dec-b631-296008658ed2</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>