REST Resource: folders.locations.frameworkComplianceReports.controlComplianceSummaries

Resource: ControlComplianceSummary

The details for control compliance.

JSON representation 
{
  "control": string,
  "displayName": string,
  "description": string,
  "overallEvaluationState": enum (EvaluationState),
  "totalFindingsCount": integer,
  "complianceFrameworks": [
    string
  ],
  "similarControls": [
    {
      object (SimilarControls)
    }
  ],
  "cloudControlReports": [
    {
      object (CloudControlReport)
    }
  ],
  "controlResponsibilityType": enum (RegulatoryControlResponsibilityType),
  "isFakeControl": boolean,
  "name": string
}
Fields
control

string

The name of the control.
displayName

string

The display name of the control.
description

string

The description of the control.
overallEvaluationState

enum (EvaluationState)

Output only. The overall evaluation status of the control.
totalFindingsCount

integer

The total number of findings for the control.
complianceFrameworks[]

string

The list of compliance frameworks that the control belongs to.
similarControls[]

object (SimilarControls)

The list of similar controls.
cloudControlReports[]

object (CloudControlReport)

The list of cloud control reports.
controlResponsibilityType

enum (RegulatoryControlResponsibilityType)

The responsibility type for the control.
isFakeControl

boolean

Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.
name

string

Identifier. The name of the control compliance summary.

EvaluationState

The evaluation state of the control.

Enums
EVALUATION_STATE_UNSPECIFIED Default value. This value is unused.
EVALUATION_STATE_PASSED The control is passing.
EVALUATION_STATE_FAILED The control is failing.
EVALUATION_STATE_NOT_ASSESSED The control is not assessed.

SimilarControls

The similar controls.

JSON representation 
{
  "framework": string,
  "controlId": string
}
Fields
framework

string

The name of the framework.
controlId

string

The ID of the control.

CloudControlReport

The cloud control report.

JSON representation 
{
  "cloudControl": string,
  "displayName": string,
  "description": string,
  "categories": [
    string
  ],
  "similarControls": [
    {
      object (SimilarControls)
    }
  ],
  "cloudControlType": enum (Type),
  "findingCategory": string,
  "rules": [
    {
      object (Rule)
    }
  ],
  "findingSeverity": enum (Severity),
  "enforcementMode": enum (EnforcementMode),
  "cloudControlDeployment": string,
  "majorRevisionId": string,
  "minorRevisionId": string,
  "frameworkMajorRevisionIds": [
    string
  ],

  // Union field assessment_details can be only one of the following:
  "manualCloudControlAssessmentDetails": {
    object (ManualCloudControlAssessmentDetails)
  },
  "cloudControlAssessmentDetails": {
    object (CloudControlAssessmentDetails)
  }
  // End of list of possible types for union field assessment_details.
}
Fields
cloudControl

string

The name of the cloud control.
displayName

string

The display name of the cloud control.
description

string

The description of the cloud control.
categories[]

string

The list of categories for the cloud control.
similarControls[]

object (SimilarControls)

The list of similar controls.
cloudControlType

enum (Type)

The type of the cloud control.
findingCategory

string

The category of the finding.
rules[]

object (Rule)

The list of rules that correspond to the cloud control.
findingSeverity

enum (Severity)

The severity of the finding.
enforcementMode

enum (EnforcementMode)

The enforcement mode of the cloud control.
cloudControlDeployment

string

The name of the cloud control deployment.
majorRevisionId

string (int64 format)

The major revision ID of the cloud control.
minorRevisionId

string (int64 format)

The minor revision ID of the cloud control.
frameworkMajorRevisionIds[]

string (int64 format)

The major revision IDs of the frameworks that the cloud control belongs to.
Union field assessment_details. The assessment details of the cloud control. assessment_details can be only one of the following:
manualCloudControlAssessmentDetails

object (ManualCloudControlAssessmentDetails)

The details of a manual cloud control assessment.
cloudControlAssessmentDetails

object (CloudControlAssessmentDetails)

The details of a cloud control assessment.

ManualCloudControlAssessmentDetails

The details for a manual cloud control assessment.

JSON representation 
{
  "manualCloudControlGuide": [
    string
  ]
}
Fields
manualCloudControlGuide[]

string

The guide for assessing a cloud control manually.

CloudControlAssessmentDetails

The cloud control assessment details for non-manual cloud controls.

JSON representation 
{
  "findingsCount": integer,
  "evaluationState": enum (EvaluationState)
}
Fields
findingsCount

integer

The number of findings for the cloud control.
evaluationState

enum (EvaluationState)

Output only. The evaluation status of the cloud control.

Type

The type of cloud control.

Enums
TYPE_UNSPECIFIED Default value. This value is unused.
CUSTOM A cloud control that's created and managed by you.
BUILT_IN A cloud control that's provided and managed by Google.

RegulatoryControlResponsibilityType

The responsibility type for the regulatory control.

Enums
REGULATORY_CONTROL_RESPONSIBILITY_TYPE_UNSPECIFIED Default value. This value is unused.
GOOGLE Google's responsibility.
CUSTOMER Your responsibility.
SHARED Shared responsibility.

Methods

list

 Lists the control compliance summary for a given scope.