Sign in
organizations

Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.

post/v1/{+scope}/auditReports:generate

Request

  • Base URL: https://auditmanager.googleapis.com
  • URL: https://auditmanager.googleapis.com/v1/{+scope}/auditReports:generate
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-auditmanager) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-auditmanager)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

scopestring required

Required. Organization, folder, or project that the audit applies to, in one of the following formats: * projects/{project}/locations/{location} * folders/{folder}/locations/{location} * organizations/{organization}/locations/{location}

Request body

gcsUristring

URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process.

complianceFrameworkstring

Required. The framework that's used for the audit report. For example, NIST_800_53.

complianceStandardstring

Optional. Deprecated. Compliance standard for the audit report. Use the compliance_framework field instead.

reportFormat'AUDIT_REPORT_FORMAT_UNSPECIFIED' | 'AUDIT_REPORT_FORMAT_ODF'

Required. Format for the audit report.

validateOnlyboolean

Optional. If true, only validates the request and does not generate the audit report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase. Use this field for the following purposes: * Infrastructure as Code (IaC): Allow tools like Terraform to run dry-run mutations (e.g., terraform plan) without creating real resources or incurring costs. * User Interface Validation: Enable real-time form and permission validation in custom UIs before submitting requests. * CI/CD & Automation: Test your scripts, permissions, and parameters safely without triggering expensive Long-Running Operations (LROs) or consuming resource quotas.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.