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/3FA9-7F00-2CF6-4A61-AA1B/sites/33c1324a-194a-4e6c-86f8-4a39b0c2275d/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": 10,
      "GroupCode": "-212680682",
      "GroupId": "344d193f-3fa2-4122-a601-72adef5dbd2e",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "b7dd331c-f345-4505-8bd8-8eccbf00e31d",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 65,
      "GroupCode": "-953329113",
      "GroupId": "b708ca8e-0cfb-499f-b086-0e60604ae349",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "4bcd10a8-9036-497f-9866-52b5434a6de5",
      "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>10</Endpoints>
      <GroupCode>-212680682</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>344d193f-3fa2-4122-a601-72adef5dbd2e</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>b7dd331c-f345-4505-8bd8-8eccbf00e31d</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>65</Endpoints>
      <GroupCode>-953329113</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>b708ca8e-0cfb-499f-b086-0e60604ae349</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>4bcd10a8-9036-497f-9866-52b5434a6de5</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>