DELETE /api/users/{userID}

Deletes the specified site user.

Authorization Roles/Permissions: Site Admin only.

This topic includes the following sections:

HTTP Method

DELETE

Back to top

URL

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

Back to top

Sample Request

The example below shows successful completion of this operation.

Request URL

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

Sample request headers

Accept: text/plain

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 text/plain

Back to top

Request Parameters

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

Back to top

Response

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

Back to top

Sample Response

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

Back to top

Response Headers

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

Header Description
Content-Type text/plain

Back to top

Response Body

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

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
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.

More information about Akana API Platform API error messages.

Back to top

Related Topics