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

Gets the list of groups on a given GSM site.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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/B1A4-9D2E-9E64-4684-A8C1/sites/90314684-8965-4181-b956-3020288b29ab/groups

Body Parameters

None.

Response Information

Resource Description

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

GetGroupsResponseModel
NameDescriptionTypeAdditional 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": 51,
      "GroupCode": "-730242007",
      "GroupId": "9c26ff84-4494-427a-9fbc-bf7532bdd3c8",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "9c21b61f-6885-4dc9-aba9-efd5b7984cca",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 81,
      "GroupCode": "-631637342",
      "GroupId": "a58c7eff-398c-4454-b606-2ac2a01bb4ab",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "2623c845-e815-4243-8a74-e223b2808099",
      "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>51</Endpoints>
      <GroupCode>-730242007</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>9c26ff84-4494-427a-9fbc-bf7532bdd3c8</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>9c21b61f-6885-4dc9-aba9-efd5b7984cca</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>81</Endpoints>
      <GroupCode>-631637342</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>a58c7eff-398c-4454-b606-2ac2a01bb4ab</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>2623c845-e815-4243-8a74-e223b2808099</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>