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/1B68-58D2-A88C-4A11-A5E1/sites/7d613273-5825-4615-88a5-cee6759cee95/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": 26,
      "GroupCode": "-148446225",
      "GroupId": "79b8f0d5-b877-42ae-9144-9b6a64c1f8fe",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "10935949-752e-4026-9cf3-8326d4416720",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 51,
      "GroupCode": "-720550783",
      "GroupId": "dfa8add0-70f4-4306-bebd-4f4b14a5975e",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "31884332-58e1-49f3-888e-03fbdf3bf113",
      "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>26</Endpoints>
      <GroupCode>-148446225</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>79b8f0d5-b877-42ae-9144-9b6a64c1f8fe</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>10935949-752e-4026-9cf3-8326d4416720</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>51</Endpoints>
      <GroupCode>-720550783</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>dfa8add0-70f4-4306-bebd-4f4b14a5975e</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>31884332-58e1-49f3-888e-03fbdf3bf113</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>