Delete User REST Endpoint

Former Member — Thu, 16 Jul 2020 20:06:46 GMT

Current Revision posted to API Documentation by Former Member on 07/16/2020 20:06:46

URLs

POST (Header: DELETE) api.ashx/v2/users/{id}.xml (or .json)

DELETE a user by user id.

POST (Header: DELETE) api.ashx/v2/users/{username}.xml (or .json)

DELETE a user by username.

Request Parameters

Name	Type	Description	Required
Id	`int?`	Either Id or Username is required.	Optional
Username	`string`	Either Id or Username is required.	Optional
ReassignedUserId	`int?`	Reassign the deleted user's content to the user with this Id. If not specified, content will be reassigned to the 'Former Member' account.	Optional
ReassignedUsername	`string`	Reassign the deleted user's content to the user with this username. If not specified, content will be reassigned to the 'Former Member' account.	Optional
DeleteAllContent	`bool`	If DeleteAllContent is set to true, ReassignUserId and ReassignUsername are ignored. User's content and related content will be deleted. (For example, if user has authored a blog post, that post and all related comments, likes, bookmarks, etc will be removed.)	Optional

Example Requests

C# REST SDK

This example uses the REST SDK to access the Community REST API within a .Net C# application. In the example, USER_NAME is the user name of the effective user for the request and OAUTH_CLIENT_ID and OAUTH_SECRET are the OAuth client ID and secret, respectively, associated to this application as configured in Administration > Integration > OAuth Clients with the "Client Credentials" grant type enabled. See the documentation for the REST SDK for more details about installation, configuration, and usage options.

var host = new ClientCredentialsRestHost("USER_NAME", "https://mysite.com/", "OAUTH_CLIENT_ID", "OAUTH_SECRET");
var response = host.DeleteToDynamic(2, "users/{id}.json", false, new RestDeleteOptions {
	PathParameters = new System.Collections.Specialized.NameValueCollection {
		{ "id", "6" }
	}
});

Widget Javascript

This example uses the [[rest JavaScript API Module|rest JavaScript API]] to access the Community REST API within the Community web UI. When accessing the REST API through the javascript API, the effective user is the current contextual user of the web interface.

jQuery.telligent.evolution.del({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/users/{id}.json',
	data: { 
		'id': '6'
	},
	success: function(response) {

	}
});

cURL

This example uses the cURL command-line HTTP utility. ENCODED_TOKEN in the example is the base64-encoded concatenation of the user's API key (created from the user's profile), a colon (:), and the user's user name. Learn more about using the REST API.

curl -H "Rest-User-Token: ENCODED_TOKEN" -H "Rest-Method: DELETE" -X POST https://mysite.com/api.ashx/v2/users/6.xml

Example Responses

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>

JSON

{
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}