User APIs

Anonymise User

OVERVIEW

NOTE : This API will be available in version 4.5 onwards

Overview

Inactivate a user within Collaborate

This API call is used to inactivate a user within the system. The user identifier is the user ID of the user.

HTTP Request

PUT   /api/4/users?status=inactive/activate/anonymise

HTTP Request Object

Request xml

<users> 
    <user> 
        <userid>102</userid>
        <userid>101</userid>
    </user>
</users>

Request JSON

{
    "user": {
        "userid": [
            "102",
            "101"
        ]
    }
}

HTTP Headers
HTTP Request Header Description Example
Authorization The API Authorisation token "Bearer XXXXXXXXXXXXX"
Accept

The format of the expected response. 

  • "application/json"
  • "application/xml"

If no parameter is set, XML is the default response given.

 "application/xml"
Content Type
  • application/xml
  • application/json
 "application/xml"

 

HTTP Response

Success

HTTP response 200 

Error

See  API Error messages 

Example HTTP Request & Response

PUT http://example.com/context/api/4/users?status=anonymise

 

Error messages

Summary Ref Code (V4) Ref Code (before V4)

A User ID is required

 109  

The following users do not exist within the system

 110  

The status of following anonymised user(s) cannot be changed.

 325  

User ID is not in proper format

 113  

 

 

Comments


0 Comments

Last Updated: Jun 10,2023