Skip to main content
Version: 2023.3

Edit group

Description

Edit a group's details.

URL

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

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

HTTP method

PUT

Request

Headers

Example header format:

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

Content-Type: application/json

Request body
ParameterDescription/Comments
Name(string) Group name.
Description(string) Group description.
GroupRoleGroup's role. Possible values are: External, Regular, DomainAdmin
Request example
{
"Name": "my updated group name",
"Description": "Updated description",
"GroupRole": "Regular"
}

Response

Response code
200 Ok