Edit group
Description
Edit a group's details.
HTTP method
PUT
Request
URL
http://{Admin API IP}:{port#}/api/v1/groups/{id}
Headers
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. |
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
Response code
200 OK