Get All SaaSDR Reporting Controls Information in Form of Evidences

Get detailed Report of all SaaSDR type controls in the form of evidences.

GETsdr/api/v1/reporting

Input ParametersInput Parameters

Parameter

Required/
Optional

Data Type

Description

policyName

Required String

Specify value as 'Policy Name' in action input parameter.

connectorId

Required Integer

Specify connector Id. (Take support of connector Id from the existing API).

connectorType

Required String

Specify list of valid connector types.
Example - Google Workspace, OFFICE365, SALESFORCE, ZOOM.

controlEvaluations

Required String

Specify valid evaluation (Pass/ Fail/ Error) or any combination of control evaluations.

pageNumber

Optional for page number 1 Integer

Specify the page number.
Default page number is 1.

Sample - Get all Reporting Controls InformationSample - Get all Reporting Controls Information

API Request

curl-k -G -H "Authorization:Bearer <Token>" "<qualys_base_url>/sdr/api/v1/reporting" --data-urlencode "policyName=<value>" --data-urlencode "controlEvalutions=<value>" --data-urlencode "connectorType=<value>" --data-urlencode "connectorId=<value>"

Response

{
   "policyName":"CIS Microsoft 365 Best Practices",
   "subscriptionId":"123456789",
   "connectorId":6748,
   "connectorType":"OFFICE365",
   "connectorName":"ofc default redis test",
   "controlEvalutaions":"Error,Pass,Fail",
   "controlSummaryDto":{
      "totalNoofControls":42,
      "passControls":10,
      "failControls":32
   },
   "controlDetailsSummaryDto":[
      {
         "cid":"70116",
         "controlName":"Ensure that DKIM is enabled for all Exchange Online Domains",
         "criticality":"High",
         "controlEvalutaionStatus":"Fail",
         "isRemediable":"No",
         "lastEvaluatedDate":"2023-09-10T07:02:03Z",
         "firstScannedDate":"2023-08-15T04:42:49Z",
         "controlEvaluationSummaryDto":[
            {
               "resourceId":"abc.mail.onmicrosoft.com",
               "resourceEvaluationResult":"Fail",
               "evidenceDetails":[
                  {
                     "evidenceKey":"DKIM Signing is enabled",
                     "evidenceSuccess":"null",
                     "evidenceFail":"false"
                  }
               ]
            },
            {
               "resourceId":"abc.com",
               "resourceEvaluationResult":"Fail",
               "evidenceDetails":[
                  {
                     "evidenceKey":"DKIM Signing is enabled",
                     "evidenceSuccess":"null",
                     "evidenceFail":"false"
                  }
               ]
            },
            {
               "resourceId":"abc.onmicrosoft.com",
               "resourceEvaluationResult":"Pass",
               "evidenceDetails":[
                  {
                     "evidenceKey":"DKIM Signing is enabled",
                     "evidenceSuccess":"true",
                     "evidenceFail":"null"
                  }
               ]
            }
         ]
      },
      {
         "cid":"70113",
         "controlName":"Ensure Advanced Threat Protection Safe Attachments policy is enabled",
         "criticality":"High",
         "controlEvalutaionStatus":"Pass",
         "isRemediable":"No",
         "lastEvaluatedDate":"2023-09-11T11:25:25Z",
         "firstScannedDate":"2023-08-15T04:42:49Z",
         "controlEvaluationSummaryDto":[
            {
               "resourceId":"64837187-a312-4982-92eb-64049df4ad12",
               "resourceEvaluationResult":"Pass",
               "evidenceDetails":[
                  {
                     "evidenceKey":"List of the threat Protection Safe Attachments policy",
                     "evidenceSuccess":"[{\"Id\":\"Built-In Protection Policy\",\"Name\":\"Built-In Protection Policy\",\"Enable\":true},{\"Id\":\"test 70113\",\"Name\":\"test 70113\",\"Enable\":true},{\"Id\":\"tr\",\"Name\":\"tr\",\"Enable\":true},{\"Id\":\"Evaluation Policy\",\"Name\":\"Evaluation Policy\",\"Enable\":true}]",
                     "evidenceFail":"null"
                  }
               ]
            }
         ]
      }
   ]
}
success Thank you! We're glad to hear that this topic was useful.
success We appreciate your feedback. We'll work to make this topic better for you in the future.