REST Resource: folders.locations.frameworkAudits

Resource: FrameworkAudit

A framework audit.

JSON representation 
{
  "name": string,
  "frameworkAuditId": string,
  "complianceFramework": string,
  "scope": string,
  "frameworkAuditDestination": {
    object (FrameworkAuditDestination)
  },
  "startTime": string,
  "finishTime": string,
  "complianceState": enum (ComplianceState),
  "reportSummary": {
    object (ReportSummary)
  },
  "cloudControlGroupAuditDetails": [
    {
      object (CloudControlGroupAuditDetails)
    }
  ],
  "cloudControlAuditDetails": [
    {
      object (CloudControlAuditDetails)
    }
  ],
  "operationId": string,
  "state": enum (State)
}
Fields
name

string

Output only. Identifier. The name of the framework audit.
frameworkAuditId

string

Output only. The ID of the framework audit.
complianceFramework

string

Output only. The compliance framework used for the audit.
scope

string

Output only. The scope of the audit.
frameworkAuditDestination

object (FrameworkAuditDestination)

Required. The destination for the audit reports.
startTime

string (Timestamp format)

Output only. The time that the audit started.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
finishTime

string (Timestamp format)

Output only. The time that the audit finished.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
complianceState

enum (ComplianceState)

Output only. The overall compliance state of the audit.
reportSummary

object (ReportSummary)

Output only. The summary of the report.
cloudControlGroupAuditDetails[]

object (CloudControlGroupAuditDetails)

Optional. The details for the cloud control groups within this audit.
cloudControlAuditDetails[]

object (CloudControlAuditDetails)

Optional. The details for the cloud controls within this audit.
operationId

string

Output only. The ID of the long-running operation.
state

enum (State)

Output only. The framework audit state of the audit.

FrameworkAuditDestination

A destination for the framework audit.

JSON representation 
{

  // Union field destination_type can be only one of the following:
  "bucket": {
    object (BucketDestination)
  }
  // End of list of possible types for union field destination_type.
}
Fields
Union field destination_type. The type of destination. destination_type can be only one of the following:
bucket

object (BucketDestination)

The Cloud Storage bucket destination.

BucketDestination

A Cloud Storage bucket destination.

JSON representation 
{
  "bucketUri": string,
  "frameworkAuditFormat": enum (Format)
}
Fields
bucketUri

string

Required. The URI of the Cloud Storage bucket.
frameworkAuditFormat

enum (Format)

Optional. The format of the framework audit.

Format

The set of options for the framework audit format.

Enums
FORMAT_UNSPECIFIED Default value. This value is unused.
ODF The format for the framework audit report is Open Document.

ComplianceState

The state of compliance after evaluation is complete.

Enums
COMPLIANCE_STATE_UNSPECIFIED Default value. This value is unused.
COMPLIANT The resource is compliant.
VIOLATION The resource has a violation.
MANUAL_REVIEW_NEEDED The resource requires manual review from you.
ERROR An error occurred while computing the resource status.
AUDIT_NOT_SUPPORTED The resource can't be audited.

ReportSummary

Additional information for an audit operation.

JSON representation 
{
  "totalCount": integer,
  "compliantCount": integer,
  "violationCount": integer,
  "manualReviewNeededCount": integer,
  "errorCount": integer
}
Fields
totalCount

integer

Output only. The total number of checks.
compliantCount

integer

Output only. The number of compliant checks.
violationCount

integer

Output only. The number of checks with violations.
manualReviewNeededCount

integer

Output only. The number of checks with "manual review needed" status.
errorCount

integer

Output only. The number of checks that can't be performed due to errors.

CloudControlGroupAuditDetails

The details for a cloud control group.

JSON representation 
{
  "cloudControlGroupId": string,
  "displayName": string,
  "description": string,
  "responsibilityType": string,
  "googleResponsibilityDescription": string,
  "googleResponsibilityImplementation": string,
  "customerResponsibilityDescription": string,
  "customerResponsibilityImplementation": string,
  "complianceState": enum (ComplianceState),
  "controlId": string,
  "controlFamily": {
    object (ControlFamily)
  },
  "cloudControlDetails": [
    {
      object (CloudControlAuditDetails)
    }
  ],
  "reportSummary": {
    object (ReportSummary)
  }
}
Fields
cloudControlGroupId

string

Output only. The ID of the cloud control group.
displayName

string

Output only. The display name of the cloud control group.
description

string

Output only. The description of the cloud control group.
responsibilityType

string

Output only. The responsibility type.
googleResponsibilityDescription

string

Output only. The description of Google's responsibility.
googleResponsibilityImplementation

string

Output only. The implementation of Google's responsibility.
customerResponsibilityDescription

string

Output only. The description of your responsibility.
customerResponsibilityImplementation

string

Output only. The implementation of your responsibility.
complianceState

enum (ComplianceState)

Output only. The compliance state of the control group.
controlId

string

Output only. The ID of the regulatory control.
controlFamily

object (ControlFamily)

Output only. The control family.
cloudControlDetails[]

object (CloudControlAuditDetails)

Output only. The details for the cloud controls within this group.
reportSummary

object (ReportSummary)

Output only. The summary of the report.

ControlFamily

The regulatory family of the control.

JSON representation 
{
  "familyId": string,
  "displayName": string
}
Fields
familyId

string

The identifier for the regulatory control family.
displayName

string

The friendly name for the regulatory control family.

CloudControlAuditDetails

The details for a cloud control audit.

JSON representation 
{
  "cloudControl": string,
  "cloudControlId": string,
  "cloudControlDescription": string,
  "complianceState": enum (ComplianceState),
  "reportSummary": {
    object (ReportSummary)
  },
  "findings": [
    {
      object (FindingDetails)
    }
  ]
}
Fields
cloudControl

string

Output only. The name of the cloud control.
cloudControlId

string

Output only. The ID of the cloud control.
cloudControlDescription

string

Output only. The description of the cloud control.
complianceState

enum (ComplianceState)

Output only. The overall status of the findings for the control.
reportSummary

object (ReportSummary)

Output only. The summary of the report.
findings[]

object (FindingDetails)

Output only. The findings for the control.

FindingDetails

The details for a finding.

JSON representation 
{
  "name": string,
  "complianceState": enum (ComplianceState),
  "observation": {
    object (ObservationDetails)
  },
  "evidence": {
    object (EvidenceDetails)
  }
}
Fields
name

string

Output only. The name of the finding.
complianceState

enum (ComplianceState)

Output only. The compliance state of the finding.
observation

object (ObservationDetails)

Output only. The observation details for the finding.
evidence

object (EvidenceDetails)

Output only. The evidence details for the finding.

ObservationDetails

The observation details for a finding.

JSON representation 
{
  "currentValue": string,
  "expectedValue": string,
  "guidance": string
}
Fields
currentValue

string

Output only. The current value.
expectedValue

string

Optional. The expected value.
guidance

string

Output only. Any guidance for the observation.

EvidenceDetails

The evidence details for a finding.

JSON representation 
{
  "resource": string,
  "service": string,
  "evidencePath": string
}
Fields
resource

string

Output only. The resource identifier.
service

string

Output only. The service identifier.
evidencePath

string

Output only. The path to the evidence.

State

The state of the framework audit.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
SCHEDULED The audit is scheduled.
RUNNING The audit is running.
UPLOADING The audit results are being uploaded.
FAILED The audit failed.
SUCCEEDED The audit completed successfully.

Methods

create

 Creates a framework audit.

get

 Gets the details for a framework audit.

list

 Lists the framework audits for a given organization, folder, or project.