Skip to content

edit-group.md

Latest commit

 

History

History
68 lines (45 loc) · 1.03 KB

edit-group.md

File metadata and controls

68 lines (45 loc) · 1.03 KB
sidebar_position 20

Edit group

Description

Edit a group's details.

URL

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

Parameter Description/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 | 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