DELETE /api/groups/{GroupID}

Deletes a group on the platform.

Authorization Roles/Permissions: Admin for the resource. Must have Delete 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

DELETE

Back to top

URL

https://{hostname}/api/groups/{GroupID}

Back to top

Sample Request

The example below shows a request to delete the specified group.

Request URL

https://{hostname}/api/groups/group24385.acmepaymentscorp

Sample request headers

Accept: application/json
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

Request Headers

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

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type */*
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
GroupID Path string Required The unique ID for a specific group.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the GroupID as confirmation that the group was deleted. A new Authorization token is included in the response since information stored in the user's cookie has changed.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: text/plain
Date: Tue, 11 Jun 2013 20:51:15 GMT
Set-Cookie: AtmoAuthToken_acmepaymentscorp=TokenID%3Da7f29dab-d2d8-11e2-87ba-b1ff53277c59%2Cclaimed_id%3Durn%3Aacme%3Auser%3A
acmepaymentscorp%3Auser12262%2CissueTime%3D1370983875182%2CexpirationTime%3D1370985674700%2CAttributesIncluded%3Dfalse%2CUser
FDN%3Duser12262%252E open%2CUserName%3Dacmepaymentscorp-JaneSaoirse%2Csig%3DgqXY4vBEhwUlidRZFfQfkJd8SFqi5u_9E6I3-9CKE2tv6A
tSKhman1zgxK3jZbCLaFjqI2Vyi1NsAGjEpynvCvbpXE_ggXvhwDF77NcNryZRXfnEzGk5mo3k8OcRYW8FSeMMw_f0pgMrOltA-BAY90XUyCZAa9LmbPci0paSUPs

Sample response body

group24385.acmepaymentscorp

Back to top

Response Headers

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

Header Description
Content-Type text/plain
Set-Cookie The set-cookie response header sets, updates, or expires the platform cookie to reflect changes made by the operation.

Back to top

Response Body

Name Type Description
GroupID GroupID The unique ID for the group that was deleted.

Back to top

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.
405 Method Not Allowed. For example, you might get this if you specified an invalid Accept header or omitted a required Content-Type header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics