Audit Manager API . folders . locations . auditScopeReports

close()

Close httplib2 connections.

generate(scope, body=None, x__xgafv=None)

Generates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework. * A list of Google Cloud services and resources that are within the scope of the framework.

Args:
  scope: string, Required. Project or folder that the audit scope report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for GenerateAuditScopeReport.
  "complianceFramework": "A String", # Required. Framework (set of controls) that the audit scope report is generated against. For example, `NIST_800_53`.
  "complianceStandard": "A String", # Optional. Deprecated. The standard (industry or regulatory requirements) that the audit scope report is run against. Use the `compliance_framework` field instead.
  "parameterOverrides": { # Optional. Maps dynamic parameter overrides by Cloud Control resource name at execution time. For example, `{"organizations/123/locations/global/cloudControls/control-1": {parameters: [...]}}`
    "a_key": { # Wrapper message to associate a list of CSC internal parameter overrides with a control name.
      "parameters": [ # The list of parameter overrides.
        { # Parameters are key-value pairs that let you provide your custom location requirements, environment requirements, or other settings that are relevant to the cloud control.
          "name": "A String", # Required. The name or key of the parameter.
          "parameterValue": { # The possible parameter value types. # Required. The value of the parameter.
            "boolValue": True or False, # Optional. A boolean value.
            "numberValue": 3.14, # Optional. A double value.
            "oneofValue": # Object with schema name: Parameter # Optional. Sub-parameter values.
            "stringListValue": { # A list of strings for the parameter value. # Optional. A repeated string.
              "values": [ # Required. The strings in the list.
                "A String",
              ],
            },
            "stringValue": "A String", # Optional. A string value.
          },
        },
      ],
    },
  },
  "reportFormat": "A String", # Required. Format for the audit scope report.
  "validateOnly": True or False, # Optional. If `true`, only validates the request and does not generate the audit scope 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 consuming resource quotas.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Audit scope report.
  "name": "A String", # Identifier. Name for the audit scope report, in one of the following formats: * `projects/{project}/locations/{location}/auditScopeReports/{audit_scope_report}` * `folders/{folder}/locations/{location}/auditScopeReports/{audit_scope_report}` * `organizations/{organization}/locations/{location}/auditScopeReports/{audit_scope_report}`
  "scopeReportContents": "A String", # Audit scope report content in byte format.
}