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/E202-F45D-01C5-4930-BBB6/sites/6376125d-4863-41a8-9765-6b43bee3490e/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": 68,
      "GroupCode": "-958820313",
      "GroupId": "f4761db0-a2dc-4c76-8430-ce12e82499e4",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "77623660-56bf-4df8-8a27-c07001590ab9",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 31,
      "GroupCode": "-666566561",
      "GroupId": "86b7dac5-4ae4-4149-8382-c51be2fd44b5",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "a34c96c1-0947-4509-bfac-63f1c9c891c5",
      "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>68</Endpoints>
      <GroupCode>-958820313</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>f4761db0-a2dc-4c76-8430-ce12e82499e4</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>77623660-56bf-4df8-8a27-c07001590ab9</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>31</Endpoints>
      <GroupCode>-666566561</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>86b7dac5-4ae4-4149-8382-c51be2fd44b5</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>a34c96c1-0947-4509-bfac-63f1c9c891c5</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>