Groups resouce

Create group

OVERVIEW

Request

POST  /groups

This API method can be used to create a new system group. Creation of site group is not supported by the API at this point in time. The method requires the group details to be posted to the API endpoint in an XML format. 

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<group>
    <guid>HighQ1</guid>
    <description>This is a test group</description>
    <name>HighQ group1</name>
    <sourcetype>Active Directory</sourcetype>
</group>

 

Please note at this point in time we only support source type of Active Directory. 

Response XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<group>
    <groupID>171</groupID>
    <link>https://domain.com/instance/api/1/groups/171</link>
</group>


Error Response

If the return code is other then 2xx or 3xx the following error object is returned.

<error>

<ref> Error reference code in at which full stack trace can be obtained</ref>

<summery> Details for the error </summery>

</error>

Note: Message with response code =500, will include all kind of error/validation messages such as name required, or any other internal error etc.

Code Meaning
201 Group created successfully
400 Problem with parsing XML or JSON object (Bad Request)
401 Unauthorized
403 Validation failed/ Forbidden
405 Method not allowed (calling api with wrong method)
500 Internal error occured while creating folder

 

 

Comments


2 Comments

Last Updated: Nov 08,2024