DELETE /api/apps/{AppID}/members/{UserID}

Removes a member from the team for the specified resource.

Authorization Roles/Permissions: Must be logged in. Must have Modify permission for the resource. App team member, Business Admin, or Site Admin.

This topic includes the following sections:

HTTP Method

DELETE

URL

https://{hostname}/api/apps/{AppID}/members/{UserID}[?Comment={Comment}]

Sample Request

The example below shows a request to remove a member from the app team.

Sample request URL

https://{hostname}/api/apps/7508586f-f637-45b7-b6a9-5949907263c6.acmepaymentscorp/members/0f2b1b02-74be-4201-a489-632bc5f81806.acmepaymentscorp?Comment=Removing%20Jonathan%20from%20the%20team%20at%20his%20request.

Sample request headers

DELETE /api/apps/7508586f-f637-45b7-b6a9-5949907263c6.acmepaymentscorp/members/0f2b1b02-74be-4201-a489-632bc5f81806.acmepaymentscorp?Comment=Removing%20Jonathan%20from%20the%20team%20at%20his%20request. HTTP/1.1
Host: {hostname}
Accept: */*
Content-Type: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

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	Any format (*/*)
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
AppID	Path	string	Required	The unique ID for a specific app.
UserID	Path	string	Required	The unique ID for a specific user.In this case it is the user being removed from the team.
Comment	Query	string	Optional	A comment entered by the user removing the team member.

Response

If successful, this operation returns HTTP status code 200, with the UserID of the removed team member.

Sample Response

In the example below, the user listed in the response body has been removed from the team.

Sample response headers

HTTP/1.1 200 OK
Content-Type: text/plain
Date: Wed, 25 Nov 2020 21:43:29 GMT
Atmo-Renew-Token: renew
Set-Cookie: Csrf-Token_acmepaymentscorp=TokenID%3D68b24a75-c5dc- ...
AtmoAuthToken_acmepaymentscorp=TokenID%3Dcd36a4bd-e600-4e99-961a-c4ca0cfc93cd%2Cclaimed_id%3Durn%3Aatmosphere%3Auser%3Aacmepaymentscorp%3A14b1902f-3dfc-43e3-b09a-81137f091b96%2CissueTime%3D1614802132363%2CexpirationTime%3D1614803992357%2C...

Sample response body

0f2b1b02-74be-4201-a489-632bc5f81806.acmepaymentscorp

Response Headers

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

Header	Description
Content-Type	text/plain
Atmo-Renew-Token	renew

Response Body

Name	Type	Description
UserID	string	The unique ID for a specific user.

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.
404	The resource could not be found.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics