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/57C7-E083-6985-400E-AFED/sites/0becc7bf-17c0-46c1-a979-26b04612777b/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": 23,
      "GroupCode": "-429393082",
      "GroupId": "eedf2543-95a2-4227-9ee7-6c5d2f6c8f79",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "8298f271-8d36-47f8-9965-6f08f09f348f",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 81,
      "GroupCode": "-156818894",
      "GroupId": "7fdc62b7-5e3a-4d12-8711-d76055637123",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "4ab63575-1f78-474f-b028-31a396b6f61d",
      "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>23</Endpoints>
      <GroupCode>-429393082</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>eedf2543-95a2-4227-9ee7-6c5d2f6c8f79</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>8298f271-8d36-47f8-9965-6f08f09f348f</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>81</Endpoints>
      <GroupCode>-156818894</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>7fdc62b7-5e3a-4d12-8711-d76055637123</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>4ab63575-1f78-474f-b028-31a396b6f61d</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>