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/0D32-A444-FCA5-4EA0-98FC/sites/ca445a1b-82e1-4975-b75a-ab249387d36e/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": 82,
      "GroupCode": "-472988054",
      "GroupId": "13ea896b-aace-4d36-94cf-89c01f8e1ca1",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "a5693f91-915c-442c-8e46-b44031d87c9b",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 74,
      "GroupCode": "-899204996",
      "GroupId": "ac1e36d9-b9ef-405d-8bb7-faf8efcc1c51",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "e207e2c2-005b-4eb0-9e1d-3c644d9d5222",
      "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>82</Endpoints>
      <GroupCode>-472988054</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>13ea896b-aace-4d36-94cf-89c01f8e1ca1</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>a5693f91-915c-442c-8e46-b44031d87c9b</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>74</Endpoints>
      <GroupCode>-899204996</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>ac1e36d9-b9ef-405d-8bb7-faf8efcc1c51</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>e207e2c2-005b-4eb0-9e1d-3c644d9d5222</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>