Lists the compliance summaries of the frameworks that are deployed in a Data Boundary scope (an organization, folder, or project).
list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists the compliance summaries of the frameworks that are deployed in a Data Boundary scope (an organization, folder, or project).

Args:
  parent: string, Required. The parent scope to list framework compliance summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}` (required)
  filter: string, Optional. A filter expression that restricts the results. Reserved for future use.
  pageSize: integer, Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
  pageToken: string, Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.
  view: string, Optional. The level of detail to return for each summary. If not specified, `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC` is used.
    Allowed values
      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC - Includes basic compliance metadata, but omits trend data.
      FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL - Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for ListDbFrameworkComplianceSummaries.
  "dbFrameworkComplianceSummaries": [ # The list of framework compliance summaries.
    { # A summary of the compliance status of a framework that's deployed in a Data Boundary scope.
      "controlAssessmentDetails": { # The details for a control assessment. # The number of passing, failing, and not assessed controls in the framework.
        "assessedPassingControlIds": [ # The list of controls that were assessed and are passing.
          "A String",
        ],
        "assessedPassingControls": 42, # The number of controls that were assessed and are passing.
        "failingControlIds": [ # The list of controls that are failing.
          "A String",
        ],
        "failingControls": 42, # The number of controls that are failing.
        "notAssessedControlIds": [ # The list of controls that aren't assessed because they require manual review.
          "A String",
        ],
        "notAssessedControls": 42, # The number of controls that aren't assessed because they require manual review.
        "passingControlIds": [ # The list of controls that are passing or not assessed.
          "A String",
        ],
        "passingControls": 42, # The number of controls that are passing or not assessed.
      },
      "controlsPassingTrend": { # The trend of a compliance metric. # Output only. The trend of passing controls over the trend duration. This field is only populated when using `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL`.
        "duration": "A String", # Output only. The duration for the trend.
        "valuePercent": 3.14, # Output only. The trend value as a percentage. The value can be positive or negative.
      },
      "findingCount": "A String", # Output only. The number of findings that were generated against the framework. This field is only populated when using `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL`.
      "framework": "A String", # The resource name of the compliance framework.
      "frameworkCategories": [ # The categories of the framework.
        "A String",
      ],
      "frameworkDisplayName": "A String", # Optional. The display name of the framework.
      "frameworkType": "A String", # The type of the framework.
      "majorRevisionId": "A String", # The major revision ID of the framework.
      "minorRevisionId": "A String", # The minor revision ID of the framework.
      "name": "A String", # Identifier. The resource name of the framework compliance summary.
      "supportedCloudProviders": [ # The cloud providers that are supported by the framework.
        "A String",
      ],
      "targetResourceDetails": [ # The details of the target resources (organizations, folders, or projects) that the framework is deployed on.
        { # The details for a target resource.
          "createTime": "A String", # The create time of the target resource.
          "frameworkDeployment": "A String", # The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`
          "majorRevisionId": "A String", # The major revision ID of the framework for the target resource.
          "minorRevisionId": "A String", # The minor revision ID of the framework for the target resource.
          "targetResource": "A String", # The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.
          "targetResourceDisplayName": "A String", # The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.
          "updateTime": "A String", # The update time of the target resource.
        },
      ],
    },
  ],
  "nextPageToken": "A String", # Output only. A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.
}
Assured Workloads API . projects . locations . dbFrameworkComplianceSummaries

Instance Methods

Method Details
