Loading ...

REST API: Delete User and Re-assign Content | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Delete User and Re-assign Content
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 5

REST API: Delete User and Re-assign Content

0 
 /5
0 (0votes)

Delete User and Re-assign Content

PUT /api/users/{UserID}

Deletes a user specified by user ID, and re-assigns the content to another user. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
PUT
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 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 to delete.
Parameters How to use Description
ReassignOption Used in the request URL as a query parameter Set to 2.
ToUsername Used in the request URL as a query parameter Username of the user to re-assign the content to.

Example Request

PUT https://myintranet.communifire.com/api/users/13?ReassignOption=2&ReplacementUsername=admin

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