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/43BA-4E5C-73BD-4B86-AD4C/sites/d04cb6a4-ebe6-472a-8291-b718950f0521/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": 27,
      "GroupCode": "-367442579",
      "GroupId": "3594b775-6f64-412b-b38d-a59d6de0ead3",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "45284e70-ea05-456c-adf0-6aa4bc3ccca8",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 76,
      "GroupCode": "-866179203",
      "GroupId": "af25a8c0-8f7f-41ec-a324-c92308ca8f7e",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "f35bb8bc-8a75-4491-9cbe-72c352cfb06f",
      "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>27</Endpoints>
      <GroupCode>-367442579</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>3594b775-6f64-412b-b38d-a59d6de0ead3</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>45284e70-ea05-456c-adf0-6aa4bc3ccca8</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>76</Endpoints>
      <GroupCode>-866179203</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>af25a8c0-8f7f-41ec-a324-c92308ca8f7e</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>f35bb8bc-8a75-4491-9cbe-72c352cfb06f</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>