Update an existing user's profile and permissions

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

Modifies an existing user account identified by the login ID. Supports updating the role, email, phone number, and computer scope. Changes take effect immediately.

Endpoints

Request URL

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

Scope

DesktopCentralCloud.Admin.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

content-typestringMandatory
application/userModification.v1+jsonapplication/userModification.v1+jsonCopied!

Specifies the request payload format. Set to application/userModification.v1+json to submit the user data in JSON format.

- Path Parameters

userIdstringMandatory

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

- Request Body

application/json
JSON Object
Hide Sub-Attributes
userNamestringMandatory

Updated username for the user.

mailIDstringMandatory

Updated email address for the user.

roleIDstringMandatory

Updated role identifier for the user. To get available role IDs, use this API. Get Role ID

computerScopeTypeintegerMandatory

Computer scope type for the user. 0 = All computers, 1 = Custom scope.

phoneNumberstringMandatory

Updated phone number for the user.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/users-cloud/{userId} \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/userModification.v1+json' \
  --data '{"computerScopeType":0,"roleID":"9502000000014452","mailID":"john.smith@example.com","userName":"john.smith"}'

Sample Request Body

Update user details including username, email, role, and scope settings.

Copied!
  {
    "computerScopeType": 0,
    "roleID": "9502000000014452",
    "mailID": "john.smith@example.com",
    "userName": "john.smith"
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
string

- HTTP code 400

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

Application-specific error code indicating the reason for the request failure.

errorMsgstring

Error message describing the cause of the error.

Possible Response Codes

200HTTP code
400HTTP code

Sample Response: HTTP 200

Copied!
  {}
                
Show full

Sample Response: HTTP 400

Error response when the user name is shorter than the minimum required length.

Copied!
  {
    "errorCode": "IAM0024",
    "errorMsg": "Parameter length of \"userName\" is shorter than minimum requirement."
  }
                
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.