PUT /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups/{groupId}

Edits a group under a given GSM site.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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/A04F-E11E-7484-47FC-AC51/sites/7350e470-731b-463b-9ce1-0e565cf6d21a/groups/10901d43-8b03-4987-a98a-67e784e16862

Body Parameters

Additional information for editing a group.

EditGroupRequestModel
NameDescriptionTypeAdditional Information
Inheritance

Value defining which policy should take effect, if a policy is specified.

  • 0 = The policy assignment of the endpoints in the group does not change. Endpoints which previously inherited their policies from the group's endpoint policy setting will inherit from the updated policy setting.
  • 1 = The new policy will be applied to all endpoints in the group.
  • 3 = No longer supported.
Default value is 0.

Note: Inheritance value 3 is no longer supported and behaves as if 0 was specified. If you used value 3 before, it is recommended to switch to value 0 instead.

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": "f1534cf5-8a60-4e1f-9ca7-c5186ce00a28"
}                    
<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>f1534cf5-8a60-4e1f-9ca7-c5186ce00a28</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).