Permanently remove a user from the organization

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Permanently deletes a user account identified by the login ID from the organization. All active sessions are terminated immediately upon deletion.

Request URL

https://{serverurl}/dcapi/users-cloud/{userId}

Scope

DesktopCentralCloud.Admin.DELETECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

acceptstringMandatory
application/userDeletion.v1+jsonapplication/userDeletion.v1+jsonCopied!

Specifies the request payload format. Set to application/userDeletion.v1+json to get the response format after user data deletion in JSON format.

- Path Parameters

userIdstringMandatory

Unique user identifier. To get user id click here. Get User Id

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request DELETE \
  --url https://appdomains/dcapi/users-cloud/{userId} \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'accept: application/userDeletion.v1+json'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
statusMsgstring

Confirmation message indicating successful user deletion.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "statusMsg": "User john.smith has been deleted successfully"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.