Loading ...

REST API: Delete User | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Delete User
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 31

REST API: Delete User

0 
 /5
0 (0votes)

Delete User

DELETE /api/users/{UserID}

Deletes a user specified by user ID, and deletes all the user's content or re-assigns the content to the anonymous user. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
DELETE
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
UserID Used in the request URL as a path parameter Unique identifier for a particular user.
Optional Parameters How to use Description
DeleteAllContent Used in the request URL as a query parameter Used to specify whether to delete all the user content to or to assign it to anonymous user.

Example Request

DELETE https://myintranet.communifire.com/api/users/13?DeleteAllContent=false

Example Response

True/false is returned as ResponseData.


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":true
}


Please Note The content type that you pass in the header of your request should be application/json.

 

Wiki Index

Pages

Intranet Software