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/CE6A-7C53-7083-47F2-86DC/sites/4a12c76f-b8c3-44ad-9435-4aed46bcd23c/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": "-304008813",
      "GroupId": "1a46bfa1-8050-4af8-bbf2-9f702d2f9d8d",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "c9ef957c-d4d9-497b-a0b4-fdd0cb08eb95",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 57,
      "GroupCode": "-282810120",
      "GroupId": "8579fdaa-a775-4e74-96b4-6539f1fed459",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "ba407dda-7fa2-4f28-bad2-ed4b2fa3f552",
      "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>-304008813</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>1a46bfa1-8050-4af8-bbf2-9f702d2f9d8d</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>c9ef957c-d4d9-497b-a0b4-fdd0cb08eb95</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>57</Endpoints>
      <GroupCode>-282810120</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>8579fdaa-a775-4e74-96b4-6539f1fed459</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>ba407dda-7fa2-4f28-bad2-ed4b2fa3f552</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>