In the the
, Identity and Access Management (IAM) allows allows
you to control user and group access to your project's resources. This section describes the IAM permissions relevant to
and the IAM roles that grant those permissions. To access the IAM console, see https://cloud.google.com/iam
- A A role is is a set of one or more permissions. A role is assigned to users and groups.
- A A permission grants grants access to a resource. Different permissions can grant different access levels to the same resource.
Tools for manage IAM policies:
- Google Cloud Console
- gcloud CLI
For more information, see https://cloud.google.com/iam/docs/granting-changing-revoking-access.
Required Roles and Their Permissions
, the following roles are required. Below, you can review each required role, its purpose, and the permissions that are enabled by it.
|Role||Use||Permissions and roles|
Enables a user to run
in a project See below.
Enables the platform to access and modify datasets and storage and to run and manage
jobs on behalf of the user within the project. For more information on this role, see https://console.cloud.google.com/iam-admin/roles/details/roles%3Cdataprep.serviceAgent.
NOTE: When the product is enabled within a project, this role is granted by the project owner as part of the enablement process. For more information, see Enable or Disable Dataprep.
roles/dataprep.projects.user IAM Role
All users of any version of of must must be assigned the the
dataprep.user IAM IAM Role.
This role and its related permissions enable access to all data in a project. Other permissions do not apply.
The following base set of IAM permissions and some additional permissions are required for accessing the product. Below, you can review the required permissions for this product edition.
Run Run on on
List available machine types for jobs
These permissions are required for connections that are common in .
Read and write to to
, the base storage for for
|storage.buckets.list||Required at project level|
|storage.buckets.get||Get bucket metadata||Required for staging bucket only|
|storage.objects.create||Create files||Required for staging bucket only|
|storage.objects.delete||Delete files||Required for staging bucket only|
|storage.objects.get||Read files||Required for staging bucket only|
|storage.objects.list||List files||Required for staging bucket only|
Permissions required to integrate with external services are considered optional.
Read and write to BigQuery, including views and custom SQL:
For Custom SQL query support and launching jobs with BigQuery data sources.
|Required at project level to use BigQuery|
|bigquery.datasets.get||List and get metadata about datasets in project||Can be applied at project level or at individual dataset level|
|bigquery.tables.create||Execute custom queries||Can be applied at project level or at individual dataset level|
|bigquery.tables.get||Create tables in dataset||Can be applied at project level or at individual dataset level|
|bigquery.tables.get||Get table metadata||Can be applied at project level or at individual dataset level|
|bigquery.tables.getData||get table contents||Can be applied at project level or at individual dataset level|
|bigquery.tables.list||List tables in dataset||Can be applied at project level or at individual dataset level|
Additional permissions may be required to use specific features. Individual users may be required to permit
access when the feature is first used.
|dataflow.jobs.cancel||Enables users | their jobs in progress
This permission is required to cancel
jobs on from within the . It is not required for the product to work but may be helpful to add via IAM roles.
NOTE: The ability to cancel a job from within the is temporarily disabled. When it is re-enabled, this permission will be required. You should leave this permission enabled, if possible.
NOTE: A user may be able cancel a job from the , even though the user is not permitted to cancel the job in the running environment. The service account associated with the user's may have the appropriate permissions, but the user's personal account does not. For more information, see Google Service Account Management.
BigQuery publishing options
|bigquery.datasets.create||Create datasets in BigQuery|
|bigquery.datasets.update||Update datasets in BigQuery|
The following permission is not required to publish to BigQuery.
If this permission is not granted to a user, that user can requires one of the following permissions to drop or truncate table data in BigQuery, only if one of the following permissions is enabled in a user's account:
- The user is granted
owner role on the project.
- The user is granted bigquery.tables.permission delete for the project.
NOTE: If a user does not have this permission when publishing to a table, the user receives a warning that the target dataset is read-only.
BigQuery job execution
To enable execution of jobs in BigQuery, the following permission must be enabled. Additional configuration may be required. For more information on this feature, see BigQuery Running Environment.
|bigquery.jobs.create||This permission enables execution of jobs within BigQuery. It is also used for custom SQL queries, which is enabled by default. In most projects, this permission is enabled by default.|
BigQuery job execution on files
If you have enabled execution of jobs in BigQuery, you can extend that capability to execute jobs for data sources hosted in . GCS execution in BigQuery requires that external tables be enabled in BigQuery. The following permissions are required to create and use external tables.
Tip: In most projects, these permissions are enabled by default.
- For more information on these permissions, see https://cloud.google.com/bigquery/external-data-cloud-storage#permissions.
- Additional configuration may be required. For more information on this feature, see BigQuery Running Environment.
Enabled in the default role.
Enabled in the default role.
|bigquery.jobs.create||Required for job execution in BigQuery. See previous section.|
Google Sheets access
|D s ed|
For more information, see Import Google Sheets Data.
Additional Permissions for Cloud IAM
|D s ed|
NOTE: Any change in a user's permissions in must be reflected in the service account assigned to the user.
Every job requires the use of a service account through which the job is submitted to for execution. Each project user must have access to a service account. For more information, see Google Service Account Management.
In addition to the IAM roles above, users must also be granted the following to enable data access based on their Cloud IAM:
These permissions ensure that users can access the appropriate data within .