REST Resource: projects.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.

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.