Retrieve all credentials

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 all credentials accessible to the authenticated user for the given customer. Supports field projection to return only specified fields.

Endpoints

Request URL

https://{serverurl}/dcapi/credentials

Scope

DesktopCentralCloud.Admin.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

fieldsstringOptional

Comma-separated list of fields to include in the response (field projection).

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/credentials \
  --header 'Accept: application/allCredentialsResponse.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Unique identifier of the credential

credentialNamestring

Administrator-defined display name for the credential

credentialUsernamestring

Username stored in the credential for authentication

credentialTypestring

Textual label of the credential type (e.g., 'Active Directory', 'Workgroup', 'BIOS')

credentialTypeIDstring

Numeric type identifier: 1 = Root Credential, 301 = Active Directory Credential, 302 = Workgroup Credential, 303 = BIOS Credential

credentialUUIDstring

Universally unique identifier (UUID) of the credential

domainIDstring

Unique identifier of the domain associated with the credential. Empty for non-domain credentials

domainNamestring

Name of the domain associated with the credential. Empty for non-domain credentials

descriptionstring

Administrator-provided description for the credential. Returns '--' if not set

userIDstring

Unique identifier of the user who created or last modified this credential

createdUserstring

Login username of the user who created this credential

isRootCredentialstring

Indicates whether this is a root credential: 1 = root credential, 0 = non-root credential

addedTimestring

Formatted timestamp of when the credential was created (e.g., 'Mar 30, 2026 04:50 PM')

modifiedTimestring

Formatted timestamp of when the credential was last modified (e.g., 'Apr 1, 2026 12:48 PM')

- HTTP code 403

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

Error code indicating insufficient permissions

errorMsgstring

Message indicating insufficient privileges to access this resource

Possible Response Codes

200HTTP code
204HTTP code
403HTTP code

Sample Response: HTTP 200

List of all credentials

Copied!
  [
    {
      "modifiedTime": "Apr 1, 2026 12:48 PM",
      "credentialTypeID": 301,
      "description": "--",
      "credentialUsername": "Administrator",
      "userID": "1",
      "domainID": "311",
      "credentialType": "Active Directory",
      "credentialUUID": "5be0e976-d613-46a0-bdc9-5a374fcadf53-1774869636432",
      "domainName": "ECSOM",
      "addedTime": "Mar 30, 2026 04:50 PM",
      "credentialID": "1",
      "credentialName": "ECSOM_root",
      "createdUser": "admin",
      "isRootCredential": 1
    }
  ]
                
Show full

Sample Response: HTTP 204

Copied!
204 No Content
Show full

Sample Response: HTTP 403

Insufficient role permissions

Copied!
  {
    "errorMessage": "Insufficient role permissions",
    "status": "403"
  }
                
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.