v1

latestSwagger 2.02026-07-17172265595.1 KB
compliance

Get top field by finding count

Retrieving the top field by finding count.

get/compliance/api/v1/compliance_result/top/{field}/{count}

Path parameters

field'resourceType' | 'integrationID' | 'resourceID' | 'service' | 'controlID' required

Field

countinteger required

Count

Query parameters

integrationIdstring[]

Connection IDs to filter by (inclusive)

notIntegrationIdstring[]

Connection IDs to filter by (exclusive)

connectionGroupstring[]

Connection groups to filter by

connectorstring[]

Connector type to filter by

benchmarkIdstring[]

BenchmarkID

controlIdstring[]

ControlID

severitiesstring[]

Severities to filter by defaults to all severities except passed

complianceStatusstring[]

ComplianceStatus to filter by defaults to all complianceStatus except passed

stateActiveboolean[]

StateActive to filter by defaults to true

jobIdstring[]

Job ID to filter

startTimeinteger

Start time to filter by

endTimeinteger

End time to filter by

intervalstring

Time interval to filter by

Response

OK

totalCountinteger

Example response

{
  "records": [
    {
      "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]"
        ]
      }
    }
  ],
  "totalCount": 100
}