System Group APIs

Update system 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 that can be updated
2. This API endpoint only supported "Active directory" system groups, now any system group can be updated 

 

HTTP Request

PUT  /api/3/groups/<GROUPID>

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

 

 

Summary

Ref code (before v4)

Ref code (v4)

The group name cannot be empty

121

121

The system group name 'Highq' already exists within the system

122

122

Group id is not in the proper format

124

124

Group id must be required   

125 125

The group does not exist within the system

126

126

Invalid input. Please remove '>' OR '<' from given input : name

142

390

Invalid input. Please remove '>' OR '<' from given input : description

142

391

An auto-created group cannot be updated

N/A 320

 

 

Comments


0 Comments

Last Updated: Jun 09,2023