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/71A3-0AF0-A008-4B8F-9298/sites/c3bc1a01-5896-4135-bf0c-5914ec2af4cf/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": 34,
      "GroupCode": "-920819880",
      "GroupId": "afafb714-df6d-45e4-878d-dc00e05e16c3",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "603928b7-a8d0-44da-a54c-0af87df3f2d2",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 21,
      "GroupCode": "-816708123",
      "GroupId": "c0b4b8a1-220c-4a2e-842a-48989be1c56d",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "b3a38aad-6b6d-4b53-bcb2-0bda82688078",
      "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>34</Endpoints>
      <GroupCode>-920819880</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>afafb714-df6d-45e4-878d-dc00e05e16c3</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>603928b7-a8d0-44da-a54c-0af87df3f2d2</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>21</Endpoints>
      <GroupCode>-816708123</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>c0b4b8a1-220c-4a2e-842a-48989be1c56d</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>b3a38aad-6b6d-4b53-bcb2-0bda82688078</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>