Page tree
Skip to end of metadata
Go to start of metadata

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. 


Request Headers

ParameterDescription
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

CodeTextDescription
403Permission deniedYou have no permissions to add group to the specified organization.
400Bad RequestThe system failed to process the request, because it did not contain all necessary parameters.
400A group with a given name already existsA group with the specified name already exists.
201CreatedA new group has been added.

 

Sample Request

 

Sample Response

  •