Fetch compliance target group association configuration

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 full configuration details for a compliance custom group (target group), including associated policies, scheduler settings, deployment status, and notification preferences

Request URL

https://{serverurl}/dcapi/scap/compliance/map/CGMapDetails

Scope

DesktopCentralCloud.VulnerabilityMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

groupResourceIdlongOptional

The resource ID of the custom group to fetch details for

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/scap/compliance/map/CGMapDetails \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Custom group resource ID

collectionIdlong

Associated collection ID

cgNamestring

Custom group name

compliancePoliciesarray

List of compliance policy group names associated with this target group

schedulerJSON Object

Scheduler configuration details including schedule type and timing

Show Sub-Attributes
statusstring

Collection deployment status

ENABLE_EMAIL_NOTIFYboolean

Whether email notifications are enabled

EMAIL_DURATIONstring

Email notification duration setting

EMAIL_ENABLED_DAYSstring

Comma-separated days when email notifications are active

EMAILstring

Notification email address

ENABLE_MOBILE_NOTIFY_FOR_USERSarray

List of users enabled for mobile notifications

- HTTP code 401

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

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 429

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

Rate limit error code returned when the API call reached threshold

errorMsgstring

Rate limit exceeded message with retry guidance

Possible Response Codes

200HTTP code
401HTTP code
429HTTP code

Sample Response: HTTP 200

Full configuration details for a compliance target group

Copied!
  {
    "scheduler": {
      "dailyTime": "02:00",
      "scheduleType": "Daily",
      "schedulerEnabled": true,
      "dailyIntervalType": "everyDay"
    },
    "compliancePolicies": [
      "CIS Windows Server 2019 L1",
      "CIS Windows Server 2019 L2"
    ],
    "ENABLE_EMAIL_NOTIFY": true,
    "customGroup": 301,
    "EMAIL_DURATION": "1",
    "EMAIL_ENABLED_DAYS": "1,2,3,4,5",
    "EMAIL": "admin@company.com",
    "ENABLE_MOBILE_NOTIFY_FOR_USERS": [
      "user1",
      "user2"
    ],
    "collectionId": 5001,
    "cgName": "Production Servers",
    "status": "Deployed"
  }
                
Show full

Sample Response: HTTP 401

User lacks scope access to the custom group

Copied!
  {
    "errorMessage": "User Not Authorized",
    "errorCode": "UAC_UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 429

API call threshold exceeded

Copied!
  {
    "errorMessage": "Rate limit exceeded. Retry after some time",
    "errorCode": "TOO_MANY_REQUESTS"
  }
                
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.