REST Resource: rowAccessPolicies

Resource: RowAccessPolicy

Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy.

JSON representation
{
  "etag": string,
  "rowAccessPolicyReference": {
    object (RowAccessPolicyReference)
  },
  "filterPredicate": string,
  "creationTime": string,
  "lastModifiedTime": string,
  "grantees": [
    string
  ]
}
Fields
etag

string

Output only. A hash of this resource.

rowAccessPolicyReference

object (RowAccessPolicyReference)

Required. Reference describing the ID of this row access policy.

filterPredicate

string

Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported.

Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0

creationTime

string (Timestamp format)

Output only. The time when this row access policy was created, in milliseconds since the epoch.

lastModifiedTime

string (Timestamp format)

Output only. The time when this row access policy was last modified, in milliseconds since the epoch.

grantees[]

string

Optional. Input only. The optional list of iamMember users or groups that specifies the initial members that the row-level access policy should be created with.

grantees types:

  • "user:alice@example.com": An email address that represents a specific Google account.
  • "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email address that represents a service account.
  • "group:admins@example.com": An email address that represents a Google group.
  • "domain:example.com":The Google Workspace domain (primary) that represents all the users of that domain.
  • "allAuthenticatedUsers": A special identifier that represents all service accounts and all users on the internet who have authenticated with a Google Account. This identifier includes accounts that aren't connected to a Google Workspace or Cloud Identity domain, such as personal Gmail accounts. Users who aren't authenticated, such as anonymous visitors, aren't included.
  • "allUsers":A special identifier that represents anyone who is on the internet, including authenticated and unauthenticated users. Because BigQuery requires authentication before a user can access the service, allUsers includes only authenticated users.

RowAccessPolicyReference

Id path of a row access policy.

JSON representation
{
  "projectId": string,
  "datasetId": string,
  "tableId": string,
  "policyId": string
}
Fields
projectId

string

Required. The ID of the project containing this row access policy.

datasetId

string

Required. The ID of the dataset containing this row access policy.

tableId

string

Required. The ID of the table containing this row access policy.

policyId

string

Required. The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

Methods

batchDelete

Deletes provided row access policies.

delete

Deletes a row access policy.

get

Gets the specified row access policy by policy ID.

getIamPolicy

Gets the access control policy for a resource.

insert

Creates a row access policy.

list

Lists all row access policies on the specified table.

testIamPermissions

Returns permissions that a caller has on the specified resource.

update

Updates a row access policy.