DELETE /api/users/{userID}

Deletes the specified site user.

Authorization Roles/Permissions: Must be logged in. Site Admin only.

This topic includes the following sections:

HTTP Method

DELETE

https://{hostname}/api/users/{userID}

The example below shows successful completion of this operation.

Sample Request URL

https://{hostname}/api/users/cb50e0c5-2bc4-4195-8932-0391ad6066bb.acmepaymentscorp

Sample request headers

Accept: text/plain
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

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

Header	Description
Accept	text/plain
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.

Parameter	Parm Type	Data Type	Required	Description
UserID	Path	string	Required	The unique ID for a specific user.

If successful, this operation returns HTTP status code 200, with the User ID of the user as confirmation that the operation was successful.

The sample response below shows successful completion of this operation. Subsequent login attempts for this user will be unsuccessful.

Sample response headers

Status Code: 200 OK
Content-Type: text/plain
Expires: Fri, 10 Apr 2015 20:09:27 GMT

Sample response body

cb50e0c5-2bc4-4195-8932-0391ad6066bb.acmepaymentscorp

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

Header	Description
Content-Type	text/plain

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

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
400	HTTP method DELETE is not supported by this URL For example, you would get this message if you included a wrong Accept header.
500	An error occurred processing the call.