Retrieve account and role details for the currently authenticated 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

Returns the user account and role details for the currently authenticated user. Exempt from strict role-based access control; accessible before sign-up completion in cloud flows.

Endpoints

Request URL

https://{serverurl}/dcapi/uac/userMeta

Scope

DesktopCentralCloud.Common.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Specifies the expected response format. Set to application/userMeta.v1+json to receive the user meta response in JSON format.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/uac/userMeta \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'accept: application/userMeta.v1+json'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
loginIDstring

Unique login identifier for the authenticated user.

userNamestring

Username of the authenticated user.

mailIDstring

Email address of the user account.

roleIDstring

Unique identifier of the role assigned to the user.

roleNamestring

Name of the role assigned to the user.

isSuperAdminboolean

Indicates whether the user has super-administrator privileges.

computerScopeTypeinteger

Computer scope type assigned to the user (0 = All computers, 1 = Custom scope).

isSDPUserboolean

Indicates whether the user is associated with the Software Deployment Platform (SDP).

accountTypestring

Account type for the user (e.g., local, ad).

loginNamestring

Display name of the user as shown in the console.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

User account and role details for the currently authenticated user.

Copied!
  {
    "computerScopeType": 0,
    "loginID": "9502000000122681",
    "roleID": "9502000000014452",
    "isSDPUser": false,
    "accountType": "local",
    "loginName": "Alex Morgan",
    "roleName": "Administrator",
    "mailID": "alex.morgan@example.com",
    "isSuperAdmin": false,
    "userName": "alex.morgan"
  }
                
Show full

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