Retrieve all domains in scope

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 domains (Active Directory and workgroup) in scope. Supports filtering by managed computers, AD type, managed users, and network type.

Endpoints

Request URL

https://{serverurl}/dcapi/som/domains

Scope

DesktopCentralCloud.SOM.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

pageintegerOptional

Specifies the page number to retrieve. Default is 1

sizestringOptional

Specifies the maximum number of items to return per page. The default value is 25. A maximum of 1000 records can be retrieved in a single request

fieldsstringOptional

Comma-separated list of fields to include in the response for projection

hasComputersbooleanOptional

If set to true, returns only domains that have managed computers

hasManagedUsersbooleanOptional

If set to true, returns only domains that have managed users

onlyADbooleanOptional

If set to true, returns only Active Directory domains

onlyDirectADbooleanOptional

If set to true, returns only directly joined Active Directory domains

networkType[]stringOptional

Filters domains by network type. Accepts multiple values. Supported values: 1 (Workgroup), 2 (Active Directory), 3 (Entra AD)

searchValuestringOptional

Search value used to filter domains based on its name

Sample Request

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

Response Parameters

- HTTP code 200

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

Unique resource identifier of the domain in the system

namestring

Short display name of the domain (typically the NetBIOS name)

domainNamestring

NetBIOS name of the domain used for authentication and network identification

adDomainNamestring

Fully qualified domain name (FQDN) of the Active Directory domain (e.g., 'corp.example.com')

isADDomainboolean

true if this is an Active Directory domain, false if it is a workgroup

guidstring

Globally unique identifier (GUID) of the domain object in Active Directory

hasCredentialsboolean

Whether authentication credentials are configured for this domain

credentialIDstring

Identifier of the credential associated with this domain. Fetch details from List Credentials

credentialUUIDstring

Universally unique identifier (UUID) of the credential associated with this domain

usernamestring

Username configured for domain access and AD operations

hasManagedComputersboolean

Whether there are any managed computers discovered under this domain

useSSLboolean

Whether SSL/TLS is used for LDAP communication with the domain controller

portNumberstring

Port number used for LDAP communication (0 indicates default port)

dcNamestring

Hostname of the domain controller used for AD sync operations

dnsSuffixstring

DNS suffix of the domain, typically matching the AD FQDN

syncTypestring

Type of domain synchronization: 1 = Direction Connection, 2- Through AD Connector

syncDetailsJSON Object

Scheduled synchronization configuration including time, frequency, and timezone

Show Sub-Attributes
syncTimestring

Scheduled sync start time in HH:mm format (e.g., '02:00' for 2 AM)

remainingSyncCountstring

Number of sync cycles remaining for the current day based on the configured frequency

timeZonestring

Timezone used for the sync schedule (e.g., 'Asia/Kolkata', 'America/New_York')

frequencystring

Automatic Sync frequency per day

dmDomainIDstring

Internal Domain Manager identifier for this domain

networkTypestring

Network type classification: 1- Workgroup, 2- Active Directory, 3 - Entra AD

adConnectorIDstring

Identifier of the AD Connector used for syncing this domain. null when no connector is configured

oauthMetaIDstring

OAuth metadata identifier for Azure AD integration. null when OAuth is not configured

oauthTypestring

Type of OAuth authentication configured (e.g., Azure AD). null when OAuth is not configured

Possible Response Codes

200HTTP code
204HTTP code

Sample Response: HTTP 200

Active Directory domain

Copied!
  [
    {
      "resourceID": "311",
      "adDomainName": "ECSOM.CBE.COM",
      "adConnectorID": null,
      "syncDetails": {
        "syncTime": "06:00",
        "remainingSyncCount": 3,
        "timeZone": "Asia/Calcutta",
        "frequency": 24
      },
      "oauthMetaID": null,
      "hasManagedComputers": false,
      "hasCredentials": true,
      "portNumber": 0,
      "useSSL": false,
      "credentialUUID": "5be0e976-d613-46a0-bdc9-5a374fcadf53-1774869636432",
      "dcName": "som-server-cbe",
      "dnsSuffix": "ECSOM.CBE.COM",
      "domainName": "ECSOM",
      "dmDomainID": "1",
      "name": "ECSOM",
      "guid": "fd7b9f4a4dbdb14b916eb513c12e43f9",
      "credentialID": "1",
      "isADDomain": true,
      "oauthType": null,
      "syncType": 1,
      "networkType": 2,
      "username": "Administrator"
    }
  ]
                
Show full

Sample Response: HTTP 204

Copied!
204 No Content
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.