Edit group

Description

Edit a group's details.

HTTP method

PUT

Request

http://{Admin API IP}:{port#}/api/v1/groups/{id}

Example header format:

Authorization: Basic <authorization token returned from the login method>

Content-Type: application/json

Parameter Description/Comments
id

(string) Group's id. Can be retrieved via Get all groups.
Parameter Description/Comments
Name (string) Group name.
Description (string) Group description.
ViewOnly (bool)
groupType  
groupRole Group's role. Possible values are: External, Regular, DomainAdmin, SystemAdmin 
{
  "Name": "my updated group name",
  "Description": "Updated description",
  "ViewOnly": true,
  "groupType": 0,
  "groupRole": "Regular",
  "Id": 0
}

Response

200 OK