Groups resouce

Update group

OVERVIEW

This API call is used to change a system group.

Note:

1. In the previous version of this API all fields were mandatory, with the new version individual fields can be updated
2. This API endpoint only supported "Active directory" system groups, now any system group can be updated using this API endpoint.

HTTP Request

PUT  /api/3/groups/<GROUP>

URL Parameters
Parameter Description
GROUPID The ID of the system group

 

Example

PUT   http://example.com/context/api/3/groups/3

HTTP Request Object

XML Request Example

 

<group>
    <guid>Highq-India</guid>
    <name>High-India3</name>
    <description>this is a test group</description> 
</group>

 

JSON Request Example

 

{
    "guid": "Highq-India",
    "name": "High-India3",
    "description": "this is a test group"
}
HTTP Response
Success

HTTP response 200

Error

See  API Error messages 

 

 

Comments


0 Comments

Last Updated: Jun 11,2023