System Group APIs

Add system group

OVERVIEW

Overview

This API call is used to add a new system group object in the system.

Request

POST  /api/3/groups

Example

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

Request Body 

XML Format

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

JSON Format

{
    "guid": "Highq-India",
    "name": "High-India3",
    "description": "this is a test group",
    "sourcetype", "Active Directory"
}

Response

HTTP response 200

Response Body

XML Format

<group>
    <groupID>171</groupID>
    <link>https://example.com/context/api/3/groups/171</link>
</group>

 

JSON Format

{
    "groupID": "171",
    "link": "https://example.com/context/api/3/groups/171"
}

Error Response

See API Error messages 

Error messages

Summary Ref code (before v4) Ref code (v4)
System group name required N/A 258
Invalid input. Please remove '>' OR '<' from given input : name N/A 390
Invalid input. Please remove '>' OR '<' from given input : description N/A 391
Invalid input for sourcetype. Valid values are Active Directory or System. N/A 359
The group name cannot be empty 121 121
The system group name 'Highq' already exists within the system 122 122

Comments


0 Comments

Last Updated: Nov 08,2024