POST /api/groups

Adds an independent group to the platform.

Authorization Roles/Permissions: Must be logged in.The user who adds the group automatically becomes the first group member. Must have Add permission for the resource.

Authorization token renewal: This operation changes information that is reflected in the authorization token; therefore, when invoking this operation, you must also renew the token.

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/groups

Sample Request

The example below shows a new group being added.

Sample Request URL

https://{hostname}/api/groups

Sample request headers

POST /api/groups HTTP/1.1
Host: {hostname}
Accept: application/json
Content-Type: application/json
AtmoAuthToken_acmepaymentscorp=TokenID%3Dcd36a4bd-e600-4e99-961a-c4ca0cfc93cd%2Cclaimed_id%3Durn%3Aatmosphere%3Auser%3Aacmepaymentscorp%3A14b1902f-3dfc-43e3-b09a-81137f091b96%2CissueTime%3D1614802132363%2CexpirationTime%3D1614803992357%2C...
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "Group":{
    "Name":"LEAD",
    "Description":"League of Extraordinary Application Developers",
    "GroupType":"com.soa.group.type.independent",
    "Visibility":"Public",
    "Tag":[
      "developers"
    ]
  }
}

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json or application/xml application/vnd.soa.v71+json or application/vnd.soa.v71+xml application/vnd.soa.v72+json or application/vnd.soa.v72+xml application/vnd.soa.v80+json or application/vnd.soa.v80+xml application/vnd.soa.v81+json or application/vnd.soa.v81+xml
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
addGroupRequest	Body	addGroupRequest	Required	Contains information about a request to add a group, including information about the group and the list of users who will be Administrators for the group. Required properties: Name, Description, GroupType.

Response

If successful, this operation returns HTTP status code 200, with information about the group, including the GroupID assigned to the new group.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 01 Dec 2020 20:37:43 GMT
Atmo-Renew-Token: renew
Set-Cookie: AtmoAuthToken_acmepaymentscorp=TokenID%3D8a2f4931-d21f-11e2-a8ac-cbfcc05f2607%2Cclaimed_id%3Durn
%3Aacme%3Auser%3Aacmepaymentscorp%3Auser12262%2CissueTime%3D1370904367894%2CexpirationTime%3D1370906167871
%2CAttributesIncluded%3Dfalse%2CUserFDN%3Duser12262%252Eopen%2CUserName%3Dacmepaymentscorp-JaneSaoirse%2Csig%3D
OVX-XWv7XRRyslthf8c7MmZRFNvBj_XzeZ90MGUSAdWZHdwq1ALn9CNFVfbdCmDpinGS7azEf0luXwZ-QQJrU7ZThWixkggVMWx47R9ZK0XVPtlW6O
CDdDkj6edeWYa4QUP7e9qYNqnr9OxXcqvyuQAxoZftBga3-iwbt1yQTMg;path=/;expires=Mon, 10-Jun-2013 23:11:07 GMT;HttpOnly

Sample response body: application/json

{
  "GroupID" : "group24385.acmepaymentscorp",
  "Name" : "LEAD",
  "Description" : "League of Extraordinary Application Developers",
  "Tag" : [ "brilliant", "advanced", "innovative", "league" ],
  "Visibility" : "Limited",
  "PictureID" : 1520,
  "GroupType" : "com.soa.group.type.independent"
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml
Atmo-Renew-Token	renew
Set-Cookie	The set-cookie response header sets, updates, or expires the platform cookie to reflect changes made by the operation.

Response Body

Name	Type	Description
Group	Group	Contains information about a group on the platform.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
405	Method Not Allowed. You might get this if there is an error in the URL, or if you used the wrong HTTP verb.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics