Method: projects.locations.dataPolicies.list

Stay organized with collections Save and categorize content based on your preferences.

List all of the data policies in the specified parent project.

HTTP request

GET https://bigquerydatapolicy.googleapis.com/v1/{parent=projects/*/locations/*}/dataPolicies

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Resource name of the project for which to list data policies. Format is projects/{project_number}/locations/{locationId}.

Query parameters

Parameters
pageSize

integer

The maximum number of data policies to return. Must be a value between 1 and 1000. If not set, defaults to 50.

pageToken

string

The nextPageToken value returned from a previous list request, if any. If not set, defaults to an empty string.

filter

string

Filters the data policies by policy tags that they are associated with. Currently filter only supports "policy_tag" based filtering and OR based predicates. Sample filter can be "policy_tag: projects/1/locations/us/taxonomies/2/policyTags/3". You may also use wildcard such as "policy_tag: projects/1/locations/us/taxonomies/2*". Please note that OR predicates cannot be used with wildcard filters.

Request body

The request body must be empty.

Response body

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

Response message for the dataPolicies.list method.

JSON representation
{
  "dataPolicies": [
    {
      object (DataPolicy)
    }
  ],
  "nextPageToken": string
}
Fields
dataPolicies[]

object (DataPolicy)

Data policies that belong to the requested project.

nextPageToken

string

Token used to retrieve the next page of results, or empty if there are no more results.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • 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:

  • bigquery.dataPolicies.list

For more information, see the IAM documentation.