Version: 2023.3

Edit group

Edit a group's details.

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

Parameter	Description/Comments
ID	(string) Group's id. Can be retrieved via Get all groups.

PUT

Headers

Example header format:

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

Content-Type: application/json

Request body

Parameter	Description/Comments
Name	(string) Group name.
Description	(string) Group description.
GroupRole	Group's role. Possible values are: External, Regular, DomainAdmin

Request example

{
  "Name": "my updated group name",
  "Description": "Updated description",
  "GroupRole": "Regular"
}

Response code

200 Ok