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/DBB9-A44F-66D9-4BDD-BCCF/sites/367486e3-1882-4b89-beec-d6070788121f/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": 91,
      "GroupCode": "-250228257",
      "GroupId": "45cc6078-6448-4409-a057-23286d163ee4",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "580c1955-e692-4d2d-8d7c-ed835976f8df",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 31,
      "GroupCode": "-371102584",
      "GroupId": "a1ff52d6-8602-473c-a305-2aa2d719963c",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "3e941ebd-81c8-4f91-8adb-c2c57becabd5",
      "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>91</Endpoints>
      <GroupCode>-250228257</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>45cc6078-6448-4409-a057-23286d163ee4</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>580c1955-e692-4d2d-8d7c-ed835976f8df</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>31</Endpoints>
      <GroupCode>-371102584</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>a1ff52d6-8602-473c-a305-2aa2d719963c</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>3e941ebd-81c8-4f91-8adb-c2c57becabd5</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>