Retrieve user accounts on a computer

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

Returns the details of a user account on a computer identified by user ID, including username, domain, account type, password policies, and lock status.

Request URL

https://{serverurl}/dcapi/inventory/computers/{resourceID}/user

Scope

DesktopCentralCloud.Inventory.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/userInfo.v1+jsonapplication/userInfo.v1+jsonCopied!

- Path Parameters

resourceIDstringMandatory

Resource identifier of the computer. Obtain from the response of the Get Computers List API.

- Query Parameters

userIDlongMandatory

User component ID to retrieve details for.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomains/dcapi/inventory/computers/{resourceID}/user?userID=SOME_INTEGER_VALUE' \
  --header 'Accept: application/userInfo.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

User account status - Active or Disabled

userDomainstring

Domain or computer name the user belongs to

passwordExpiresstring

Whether the password expires - Yes or No

isPasswordRequiredstring

Whether a password is required - Yes or No

isLocalAccountstring

Whether this is a local account - Yes or No

userSidTypestring

SID type - User, Group, etc.

accountTypestring

Account type - Normal Account, Temp Duplicate Account, etc.

userFullNamestring

Full name of the user

userFullNameWithDomainstring

Full name with domain prefix (DOMAIN\Username)

userNamestring

User account name

userSIDstring

Security Identifier (SID) of the user

userComponentIDstring

User component identifier

descriptionstring

Description of the user account

isDisabledstring

Whether the account is disabled - Yes or No

isPasswordChangeablestring

Whether the password can be changed - Yes or No

isLockedOutstring

Whether the account is locked out - Yes or No

- HTTP code 401

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

UAC_UNAUTHORIZED - user lacks the required uem-roles or credentials are missing

error_descriptionstring

Authentication or authorization failure reason

- HTTP code 404

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

RESOURCE_NOT_AVAILABLE - the specified resourceID does not exist or is not accessible

error_descriptionstring

Resource not found message

- HTTP code 500

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

INTERNAL_ERROR - unexpected exception in the service layer

error_descriptionstring

Internal server error message

Possible Response Codes

200HTTP code
401HTTP code
404HTTP code
500HTTP code

Sample Response: HTTP 200

User account details

Copied!
  {
    "isLockedOut": "No",
    "userStatus": "Active",
    "accountType": "Normal Account",
    "userFullName": "--",
    "description": "Built-in account for administering the computer/domain",
    "userDomain": "SAMPLE-PC",
    "userName": "SampleUser",
    "passwordExpires": "Yes",
    "isLocalAccount": "Yes",
    "userComponentID": "1",
    "isPasswordRequired": "Yes",
    "userSidType": "User",
    "userSID": "S-1-5-21-0000000000-0000000000-0000000000-500",
    "userFullNameWithDomain": "SAMPLE-PC\\SampleUser",
    "isPasswordChangeable": "Yes",
    "isDisabled": "No"
  }
                
Show full

Sample Response: HTTP 401

Missing credentials

Copied!
  {
    "error_description": "Unauthorized access",
    "error_code": "UAC_UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 404

Resource not found

Copied!
  {
    "error_description": "The specified resource was not found",
    "error_code": "RESOURCE_NOT_AVAILABLE"
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "error_description": "Internal server error",
    "error_code": "INTERNAL_ERROR"
  }
                
Show full

Duration: 1 minute | Threshold: 120 | 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.