Method: folders.locations.auditReports.generate

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

HTTP request

POST https://auditmanager.googleapis.com/v1/{scope=folders/*/locations/*}/auditReports:generate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
scope

string

Required. Scope for which the AuditScopeReport is required. Must be of format resourceType/resource_identifier Eg: projects/{project}/locations/{location}, folders/{folder}/locations/{location}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "complianceStandard": string,
  "reportFormat": enum (AuditReportFormat),
  "complianceFramework": string,

  // Union field destination can be only one of the following:
  "gcsUri": string
  // End of list of possible types for union field destination.
}
Fields
complianceStandard

string

Required. Compliance Standard against which the Scope Report must be generated. Eg: FEDRAMP_MODERATE
reportFormat

enum (AuditReportFormat)

Required. The format in which the audit report should be created.
complianceFramework

string

Required. Compliance framework against which the Report must be generated.
Union field destination. Set of options for the report destination location. destination can be only one of the following:
gcsUri

string

Destination Cloud storage bucket where report and evidence must be uploaded. The Cloud storage bucket provided here must be selected among the buckets entered during the enrollment process.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the scope resource:

  • auditmanager.auditReports.generate

For more information, see the IAM documentation.