REST Resource: folders.locations.auditReports

Resource: AuditReport

An audit report.

JSON representation 
{
  "name": string,
  "reportSummary": {
    object (ReportSummary)
  },
  "operationId": string,
  "destinationDetails": {
    object (DestinationDetails)
  },
  "complianceStandard": string,
  "scope": string,
  "createTime": string,
  "controlDetails": [
    {
      object (ControlDetails)
    }
  ],
  "reportGenerationState": enum (ReportGenerationState),
  "complianceFramework": string,
  "scopeId": string
}
Fields
name

string

Identifier. The name of this Audit Report, in the format of scope given in request.
reportSummary

object (ReportSummary)

Output only. Report summary with compliance, violation counts etc.
operationId

string

Output only. ClientOperationId
destinationDetails

object (DestinationDetails)

Output only. The location where the generated report will be uploaded.
complianceStandard

string

Output only. Compliance Standard.
scope

string

Output only. The parent scope on which the report was generated.
createTime

string (Timestamp format)

Output only. Creation time of the audit report.

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".
controlDetails[]

object (ControlDetails)

Output only. The overall status of controls
reportGenerationState

enum (ReportGenerationState)

Output only. The state of Audit Report Generation.
complianceFramework

string

Output only. Compliance Framework of Audit Report
scopeId

string

Output only. The ID/ Number for the scope on which the audit report was generated.

ReportSummary

The additional information for an audit operation.

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

integer

Total number of checks.
compliantCount

integer

Number of compliant checks.
violationCount

integer

Number of checks with violations.
manualReviewNeededCount

integer

Number of checks with "manual review needed" status.
errorCount

integer

Number of checks that could not be performed due to errors.

ControlDetails

The evaluation details for a control.

JSON representation 
{
  "control": {
    object (Control)
  },
  "complianceState": enum (ComplianceState),
  "controlReportSummary": {
    object (ReportSummary)
  }
}
Fields
control

object (Control)

The control for which the findings are being reported.
complianceState

enum (ComplianceState)

Output only. Overall status of the findings for the control.
controlReportSummary

object (ReportSummary)

Report summary with compliance, violation counts etc.

Control

A control.

JSON representation 
{
  "id": string,
  "displayName": string,
  "family": enum (Family),
  "controlFamily": {
    object (ControlFamily)
  },
  "description": string,
  "responsibilityType": string,
  "googleResponsibilityDescription": string,
  "googleResponsibilityImplementation": string,
  "customerResponsibilityDescription": string,
  "customerResponsibilityImplementation": string
}
Fields
id

string

Output only. The control identifier used to fetch the findings. This is same as the control report name.
displayName

string

Output only. Display name of the control.
family

enum (Family)

Output only. Group where the control belongs. E.g. Access Control.
controlFamily

object (ControlFamily)

Output only. Regulatory Family of the control E.g. Access Control
description

string

Output only. Regulatory control ask of the control
responsibilityType

string

Output only. The type of responsibility for implementing this control. It can be google, customer or shared.
googleResponsibilityDescription

string

Output only. Description of the google responsibility for implementing this control.
googleResponsibilityImplementation

string

Output only. Implementation of the google responsibility for implementing this control.
customerResponsibilityDescription

string

Output only. Description of the customer responsibility for implementing this control.
customerResponsibilityImplementation

string

Output only. Implementation of the customer responsibility for implementing this control.

Family

The family of the control. For example, Access Control.

Enums
FAMILY_UNSPECIFIED Unspecified. Invalid state.
AC Access Control
AT Awareness and Training
AU Audit and Accountability
CA Certification, Accreditation and Security Assessments
CM Configuration Management
CP Contingency Planning
IA Identification and Authentication
IR Incident Response
MA Maintenance
MP Media Protection
PE Physical and Environmental Protection
PL Security Planning
PS Personnel Security
RA Risk Assessment
SA System Services and Acquisition
SC System and Communications Protection
SI System and Information Integrity
SR Supply Chain Risk Management

ControlFamily

The regulatory family of the control.

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

string

The ID of the regulatory control family.
displayName

string

The display name of the regulatory control family.

ComplianceState

The compliance state after evaluation.

Enums
COMPLIANCE_STATE_UNSPECIFIED Unspecified. Invalid state.
COMPLIANT Compliant.
VIOLATION Violation.
MANUAL_REVIEW_NEEDED MANUAL_REVIEW_NEEDED, requires manual review
ERROR Error while computing status.
AUDIT_NOT_SUPPORTED Cannot be audited

ReportGenerationState

The different states of the Audit Manager report generation.

Enums
REPORT_GENERATION_STATE_UNSPECIFIED Unspecified. Invalid state.
IN_PROGRESS Audit report generation process is in progress, ie. operation state is neither OPERATION_STATE_DONE nor OPERATION_STATE_FAILED.
COMPLETED Audit report generation process is completed. Operation state is OPERATION_STATE_DONE.
FAILED Audit report generation process has failed. Operation state is OPERATION_STATE_FAILED.
SUMMARY_UNKNOWN Audit report generation process has completed. But report summary is unknown. This is valid for older reports.

Methods

generate

 Register the Audit Report generation requests and returns the OperationId using which the customer can track the report generation progress.

get

 Get the overall audit report

list

 Lists audit reports in the selected parent scope