Sign in

v1

latestSwagger 2.02026-07-17172265595.1 KB
compliance

Get benchmark summary

Retrieving a summary of a benchmark and its associated checks and results.

get/compliance/api/v1/benchmarks/{benchmark_id}/summary

Path parameters

benchmark_idstring required

Benchmark ID

Query parameters

integrationIdstring[]

Connection IDs to filter by

connectionGroupstring[]

Connection groups to filter by

resourceCollectionstring[]

Resource collection IDs to filter by

connectorstring[]

Connector type to filter by

timeAtinteger

timestamp for values in epoch seconds

topAccountCountinteger

Top account count

Response

OK

autoAssignboolean

Whether the benchmark is auto assigned or not

categorystring

Benchmark category

childrenstring[]

Benchmark children

controlsstring[]

Benchmark controls

costImpactnumber
createdAtstring

Benchmark creation date

descriptionstring

Benchmark description

documentURIstring

Benchmark document URI

evaluatedAtstring
idstring

Benchmark ID

integrationTypesstring[]

Benchmark connectors

lastJobStatusstring
logoURIstring

Benchmark logo URI

referenceCodestring

Benchmark display code

tagsobject

Benchmark tags

titlestring

Benchmark title

tracksDriftEventsboolean

Whether the benchmark tracks drift events or not

updatedAtstring

Benchmark last update date

Example response

{
  "autoAssign": true,
  "checks": {
    "criticalCount": 1,
    "highCount": 1,
    "lowCount": 1,
    "mediumCount": 1,
    "noneCount": 1
  },
  "description": "The CIS Microsoft Azure Foundations Security Benchmark provides prescriptive guidance for establishing a secure baseline configuration for Microsoft Azure.",
  "documentURI": "benchmarks/azure_cis_v140.md",
  "evaluatedAt": "2020-01-01T00:00:00Z",
  "id": "azure_cis_v140",
  "lastJobStatus": "success",
  "referenceCode": "CIS 1.4.0",
  "title": "Azure CIS v1.4.0",
  "topConnections": [
    {
      "control": {
        "cliRemediation": "To enable multi-factor authentication for a user, run the following command...",
        "connector": [
          "Azure"
        ],
        "createdAt": "2020-01-01T00:00:00Z",
        "description": "Enable multi-factor authentication for all user credentials who have write access to Azure resources. These include roles like 'Service Co-Administrators', 'Subscription Owners', 'Contributors'.",
        "documentURI": "benchmarks/azure_cis_v140_1_1.md",
        "enabled": true,
        "explanation": "Multi-factor authentication adds an additional layer of security by requiring users to enter a code from a mobile device or phone in addition to their username and password when signing into Azure.",
        "guardrailRemediation": "To enable multi-factor authentication for a user, run the following command...",
        "id": "azure_cis_v140_1_1",
        "managed": true,
        "manualRemediation": "To enable multi-factor authentication for a user, run the following command...",
        "manualVerification": true,
        "nonComplianceCost": "Non-compliance to this control could result in several costs including...",
        "programmaticRemediation": "To enable multi-factor authentication for a user, run the following command...",
        "query": {
          "createdAt": "2023-06-07T14:00:15.677558Z",
          "engine": "steampipe-v0.5",
          "id": "azure_ad_manual_control",
          "integrationType": [
            "Azure"
          ],
          "listOfTables": [
            "null"
          ],
          "parameters": [
            {
              "key": "key",
              "required": true
            }
          ],
          "primaryTable": "null",
          "queryToExecute": "select\n  -- Required Columns\n  'active_directory' as resource,\n  'info' as status,\n  'Manual verification required.' as reason;\n",
          "updatedAt": "2023-06-16T14:58:08.759554Z"
        },
        "title": "1.1 Ensure that multi-factor authentication status is enabled for all privileged users",
        "updatedAt": "2020-01-01T00:00:00Z",
        "usefulExample": "Access to resources must be closely controlled to prevent malicious activity like data theft..."
      },
      "resourceType": {
        "count": 100,
        "integration_type": "Azure",
        "logo_uri": "https://opengovernance.io/logo.png",
        "old_count": 90,
        "resource_name": "VM",
        "resource_type": "Microsoft.Compute/virtualMachines",
        "service_name": "compute",
        "tags": [
          "category:[Data and Analytics",
          "Database",
          "Integration",
          "Management Governance",
          "Storage]"
        ]
      }
    }
  ],
  "tracksDriftEvents": true
}