Retrieve detailed information about a specific user

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

Retrieves the complete profile of a user identified by the login ID, including assigned role, email, phone number, and computer scope settings.

Endpoints

Request URL

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

Scope

DesktopCentralCloud.Admin.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- 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 GET \
  --url https://appdomains/dcapi/users-cloud/{userId} \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Phone number associated with the user account.

roleIDstring

Unique identifier of the role assigned to the user.

roleNamestring

Name of the role assigned to the user.

mailIDstring

Email address of the user.

userNamestring

Username of the user.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "computerScopeType": 0,
    "phoneNumber": "1231231231",
    "roleID": "9502000000014452",
    "isSDPUser": false,
    "roleName": "Administrator",
    "mailID": "john.smith@example.com",
    "userName": "john.smith"
  }
                
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.