Remove User

Description

This operation deletes a specific user from the Users data table.

Method

DELETE

The signature presented below expects the "objectId" to delete a user record from the data table. The "objectId" property is a unique identifier assigned by Backendless to the user account.

Endpoint URL

The xxxx.backendless.app is a subdomain assigned to your application. For more information see the Client-side Setup section of this documentation.

https://xxxx.backendless.app/api/data/<table-name>/<objectId>

where:

Argument	Description
<table-name>	Name of the table where the object needs to be deleted.
<objectId>	Unique identifier of a user record to delete from the data table.

Request Headers

user-token:value-of-the-user-token-header-from-login

where:

Argument	Description
user-token	Optional header. Contains a value returned by Backendless in a preceding user Login API call. If user-tokenis set in the request, the operation will be executed with the security policy associated with the currently logged in user. This means all permissions associated with the user and roles assigned to the user will be enforced by Backendless.

Request Body

None.

Response Body

The JSON object containing a timestamp when the Backendless server has removed the object from the data store.

Example

The example below deletes the user record associated with the following objectId: "4D584E4D-05A3-4AC4-90C7-B80D1584E7AD".

curl --location --request DELETE 'https://xxxx.backendless.app/api/users/4D584E4D-05A3-4AC4-90C7-B80D1584E7AD'

Codeless Reference

where:

Argument	Description
objectId	Unique identifier of a user record that must be deleted from the Users data table.

Returns the timestamp when the Backendless server has removed the object from the data store.

Consider the following record in the Users data table:

The example below removes the user "alice@yourmail.com" associated with the objectId: "4D584E4D-05A3-4AC4-90C7-B80D1584E7AD".

The output will look as shown below after the Codeless logic runs: