GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups/{groupId}
Gets information about a group.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
gsmKey |
The GSM console keycode. |
string |
Required |
siteId |
The site identifier. |
string |
Required |
groupId |
The group identifier. |
string |
Required |
URI Sample(s)
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/8A79-38CA-7D15-42A9-A874/sites/d74edf9b-61c9-4512-bcbe-0eaf4a28a83a/groups/49cdf74f-5c6f-4ff6-ad4c-f99a82e0be08
|
Body Parameters
None.
Response Information
Resource Description
Information about the desired group.
GetGroupsResponseModelName | 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": 1, "Groups": [ { "Endpoints": 44, "GroupCode": "-218340873", "GroupId": "6a20a9fa-30f5-4510-be67-a0558d08e6e0", "GroupName": "Test Group 1", "GroupDescription": "Description of test group 1", "GroupPolicyId": "05def70e-ea43-4bad-b21f-976586b356b4", "GroupPolicyName": "Test Policy 1" } ] }
<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>44</Endpoints> <GroupCode>-218340873</GroupCode> <GroupDescription>Description of test group 1</GroupDescription> <GroupId>6a20a9fa-30f5-4510-be67-a0558d08e6e0</GroupId> <GroupName>Test Group 1</GroupName> <GroupPolicyId>05def70e-ea43-4bad-b21f-976586b356b4</GroupPolicyId> <GroupPolicyName>Test Policy 1</GroupPolicyName> </GetGroupsResponseModel_Group> </Groups> <TotalCount>1</TotalCount> </GetGroupsResponseModel>