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. Name of the audit report, in one of the following formats:

  • projects/{project}/locations/{location}/auditReports/{auditReport}
  • folders/{folder}/locations/{location}/auditReports/{auditReport}
  • organizations/{organization}/locations/{location}/auditReports/{auditReport}
reportSummary

object (ReportSummary)

Output only. Report summary that includes information about compliance and violation counts.
operationId

string

Output only. Client operation ID for the audit report.
destinationDetails

object (DestinationDetails)

Output only. Cloud Storage bucket where the audit report is uploaded to.
complianceStandard
(deprecated)

string

Output only. Deprecated. Compliance standard to be audited against.

Use the complianceFramework field instead.
scope

string

Output only. Organization, folder, or project that the report is generated for, in one of the following formats:

  • projects/{project}/locations/{location}
  • folders/{folder}/locations/{location}
  • organizations/{organization}/locations/{location}
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. Overall status of the controls.
reportGenerationState

enum (ReportGenerationState)

Output only. State of audit report generation.
complianceFramework

string

Output only. Compliance framework to use for the audit report. For example, CIS_GCP_FOUNDATIONS_V1_2_0.
scopeId

string

Output only. Project number, folder ID, or organization ID that the audit report was generated for.

ReportSummary

Additional information about the number of checks that were made during an audit operation.

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

integer

Total number of evaluated checks.
compliantCount

integer

Number of compliant checks.
violationCount

integer

Number of checks with violations.
manualReviewNeededCount

integer

Number of checks that require a manual review.
errorCount

integer

Number of checks that can't be performed due to errors.

ControlDetails

Evaluation details for a control.

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

object (Control)

Control that the findings are being reported for.
complianceState

enum (ComplianceState)

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

object (ReportSummary)

A control report summary that provides a high-level overview of the compliance controls and the assessment status.

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. Control identifier that's used to fetch the findings. The identifier is the same as the control report name.
displayName

string

Output only. Display name of the control.
family

enum (Family)

Output only. Category that the control belongs to.
controlFamily

object (ControlFamily)

Output only. Regulatory family of the control.
description

string

Output only. Description of the control.
responsibilityType

string

Output only. Who is responsible for implementing this control. Set to one of the following values: GOOGLE, CUSTOMER, or SHARED.
googleResponsibilityDescription

string

Output only. A description of Google's responsibility for this control.
googleResponsibilityImplementation

string

Output only. A description of how Google implements its responsibility for this control.
customerResponsibilityDescription

string

Output only. A description of your responsibility for this control.
customerResponsibilityImplementation

string

Output only. A description of how you can implement your responsibility for this control.

Family

Category of the control.

Enums
FAMILY_UNSPECIFIED Default value. This value is unused.
AC Access control.
AT Awareness and training.
AU Audit and accountability.
CA Certification, accreditation and security assessments.
CM Configuration management and change control.
CP Contingency planning and disaster recovery.
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

Regulatory family of the control.

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

string

ID of the regulatory control family. To find the list of supported control families, use the ListControls method and review the controlFamily field in the response.
displayName

string

Display name of the regulatory control family.

ComplianceState

Compliance state after evaluation.

Enums
COMPLIANCE_STATE_UNSPECIFIED Default value. This value is unused.
COMPLIANT The resource is compliant.
VIOLATION The resource isn't compliant.
MANUAL_REVIEW_NEEDED You must complete a manual review.
ERROR An error was encountered during the evaluation or evidence gathering process.
AUDIT_NOT_SUPPORTED The resource can't be audited.

ReportGenerationState

Different states of report generation.

Enums
REPORT_GENERATION_STATE_UNSPECIFIED Default value. This value is unused.
IN_PROGRESS The process is in progress. The operation can have any state except for OPERATION_STATE_DONE or OPERATION_STATE_FAILED.
COMPLETED The process is completed. The operation state is OPERATION_STATE_DONE.
FAILED The process has failed. The operation state is OPERATION_STATE_FAILED.
SUMMARY_UNKNOWN The process completed, but the report summary's status is unknown. This state isn't used for new reports.

Methods

generate

 Registers audit report generation requests.

get

 Gets the full metadata and findings for an audit report.

list

 Lists the audit reports for the organization, folder, or project that you specify as the parent scope.