PUT /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups/{groupId}
Edits a group under 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 |
| groupId |
The group identifier. |
string |
Required |
URI Sample(s)
|
PUT
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/753A-6D57-6786-4CB6-8B00/sites/8ea58445-4a76-475d-8922-e84397797825/groups/d99844d1-04c3-4343-9ee9-c4a4fc955736
|
Body Parameters
Additional information for editing a group.
EditGroupRequestModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| Inheritance |
Value defining which policy should take effect, if a policy is specified.
|
integer |
None. |
| GroupName |
The name of the group. |
string |
None. |
| GroupDescription |
The description of the group. |
string |
None. |
| PolicyId |
The id of the policy that should be applied to the group. |
string |
None. |
Sample Request
{
"Inheritance": 0,
"GroupName": "Renamed test group",
"GroupDescription": "Description of renamed test group",
"PolicyId": "1b20544c-ffe8-47c7-931a-f08a4b3c39fd"
}
<EditGroupRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <GroupDescription>Description of renamed test group</GroupDescription> <GroupName>Renamed test group</GroupName> <Inheritance>0</Inheritance> <PolicyId>1b20544c-ffe8-47c7-931a-f08a4b3c39fd</PolicyId> </EditGroupRequestModel>
Response Information
Resource Description
None. If successful, this API action does not return any data and the response status code will be 204 (No Content).