You can add a group by sending the POST request to the following URL: /group.
Permission to run the request: Account Owner, Administrator, Organization Administrator.
Parameter | Description |
---|
X-Auth-Account-Url (required) | Base URL of the account, e.g. http://myaccount.ispringlearn.com |
X-Auth-Email (required) | Administrator e-mail address. |
X-Auth-Password (required) | Administrator password. |
X-Name (required) | A name of the new group. |
X-Description (optional) | A description of the new group. |
X-Organization-Id (optional) | Organization ID where the group will be created. |
After the request has been completed, the system returns the response with Code 201. The body of the response contains ID of the added group.
Possible Response Codes
Code | Text | Description |
---|
403 | Permission denied | You have no permissions to add group to the specified organization. |
400 | Bad Request | The system failed to process the request, because it did not contain all necessary parameters. |
400 | A group with a given name already exists | A group with the specified name already exists. |
201 | Created | A new group has been added. |
Sample Request
POST /group HTTP/1.1
Host: api.ispringonline.com
X-Auth-Account-Url: http://myaccount.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password
X-Name: New group
X-Organization-Id: 2
X-Description: description
XML
Sample Response
HTTP/1.1 201 Created
Connection: close
<group_id>
XML