users/{userid}/properties/{key} (DELETE)

Overview

Remove a user property

REST Method: DELETE
Method Access: public

Uri Parameters

Name	Type	Description
userid	string	either an integer user ID, "current", or "=" followed by a double uri-encoded user name
key	string	A unique identifier for a property that is obtained through GET:users/{userid}/properties

Query Parameters

Name	Type	Description
redirects	int?	If zero, do not follow page redirects.
authenticate	bool?	Force authentication for request (default: false)

Return Codes

Name	Value	Description
OK	200	The request completed successfully
Bad Request	400	Invalid input parameter or request body
Forbidden	403	ADMIN access is required to access other user's properties
Not Found	404	Requested user and/or property could not be found

Implementation Notes

A user may only read, write, and delete their own properties. Admins can read/write/delete anyones users properties.
A current eTag is not required for deleting a property

C# Code Sample: Delete a User Property

The following code authenticates and deletes a user property named 'foo'.

Sample Code


Plug p = Plug.New("http://devwiki/@api/deki"); 
p.At("users", "authenticate")
 .WithCredentials("sysop", "password").Get(); 
p.At("users", "current", "properties", "foo")
 .Delete();

Implementation notes

Add notes about requirements or config values

Curl Code Sample: Delete a User Property

The following command deletes property "foo" attached to user "bar":

Sample Code

curl -u username:password -X DELETE -i http://mindtouch.address/@api/deki/user/=bar/properties/foo

Implementation notes

curl flags

-u: Provides external user authentication.
-X: Specifies the HTTP request method.
-i: Outputs the HTTP response headers. Useful for debugging.