Method: organizations.locations.orgPolicyViolationsPreviews.list

orgPolicyViolationsPreviews.list lists each OrgPolicyViolationsPreview in an organization. Each OrgPolicyViolationsPreview is available for at least 7 days.

HTTP request

GET https://policysimulator.googleapis.com/v1beta/{parent=organizations/*/locations/*}/orgPolicyViolationsPreviews

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent the violations are scoped to. Format: organizations/{organization}/locations/{location}

Example: organizations/my-example-org/locations/global

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 5 items will be returned. The maximum value is 10; values above 10 will be coerced to 10.
pageToken

string

Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page.

When paginating, all other parameters must match the call that provided the page token.

Request body

The request body must be empty.

Response body

ListOrgPolicyViolationsPreviewsResponse is the response message for OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "orgPolicyViolationsPreviews": [
    {
      object (OrgPolicyViolationsPreview)
    }
  ],
  "nextPageToken": string
}
Fields
orgPolicyViolationsPreviews[]

object (OrgPolicyViolationsPreview)

The list of OrgPolicyViolationsPreview
nextPageToken

string

A token that you can use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.

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 parent resource:

  • policysimulator.orgPolicyViolationsPreviews.list

For more information, see the IAM documentation.