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.
...
D s dataflow |
to manage security and permissions while running
jobs, see https://cloud.google.com/dataflow/docs/concepts/security-and-permissions#security_and_permissions_for_pipelines_on_google_cloud_platform.Tools for manage IAM policies:...
...
...
For more information, see https://cloud.google.com/iam/docs/
...
granting-changing-revoking-access.
Required Roles and Their Permissions
To use
, 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 |
---|
roles/dataprep.projects.user | Enables a user to run in a project See below. | Permissions: dataprep.projects.use resourcemanager.projects.get serviceusage.quotas.get serviceusage.services.get serviceusage.services.list
|
roles/dataprep.serviceAgent | 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. Info |
---|
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. |
| Permissions: Roles: roles/dataflow.developer roles/bigquery.user roles/bigquery.dataEditor roles/storage.objectAdmin roles/iam.serviceAccountUser
|
roles/dataprep.projects.user IAM Role
All users of any version of of
must must be assigned the the roles/
dataprepdataprep.projects.user
IAM IAM Role. Warning |
---|
This role and its related permissions enable access to all data in a project. Other permissions do not apply. |
...
...
...
...
...
PermissionsThe 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.
General
- resourcemanager.projects.get
BigQuery
Read and write to BigQuery, including views and custom SQL:
...
Info |
---|
NOTE: These permissions provide basic access to the . Additional features within the product or available through external integrations are considered optional. |
General
Permission | Product Use |
---|
dataprep.projects.use | |
resourcemanager.projects.get | |
Run Run
on on :
Permission | Product Use |
---|
compute.machineTypes.get | List available machine types for jobs |
dataflow.jobs.create | |
dataflow.jobs.get | |
dataflow.messages.list | |
dataflow.metrics.get | |
Connection Permissions
These permissions are required for connections that are common in
.Read and write to to
, the base storage
for for :
Permission | Product Use | Requirement |
---|
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 |
BigQuery
Read and write to BigQuery, including views and custom SQL:
Permission | Product Use | Requirement |
---|
bigquery.jobs.create | 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 |
Feature Permissions
Additional permissions may be required to use specific features. Individual users may be required to permit
access when the feature is first used.
job cancellation
...
Permission | Product Use |
---|
dataflow.jobs.cancel | 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. |
...
Info |
---|
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. |
Info |
---|
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
The following permissions are required to publish to BigQuery:
Permission | Product Use |
---|
bigquery.datasets.create | Create datasets in BigQuery |
bigquery.datasets.update | Update datasets in BigQuery |
The following permission is not required to publish to BigQuery.
Permission | Product Use |
---|
bigquery.tables.delete |
...
If this permission is not granted to a user, that user |
...
requires one of the following permissions to drop or truncate table data in BigQuery |
...
: - The user is granted
editor or owner role on the project. - The user is granted bigquery.tables.delete for the project.
Info |
---|
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.
Permission | Product Use |
---|
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
filesIf 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 |
---|
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.
Permission | Product Use |
---|
bigquery.tables.create | Enabled in the default role. |
bigquery.tables.getData | Enabled in the default role. |
bigquery.jobs.create | Required for job execution in BigQuery. See previous section. |
Google Sheets access
D s ed |
---|
r | true |
---|
editions | gdpstgdpent,gdppro,gdpsta,gdppr,gdpst |
---|
|
For more information, see Import Google Sheets Data.
Additional Permissions for Cloud IAM
D s ed |
---|
r | true |
---|
editions | gdpent,gdppr |
---|
|
Info |
---|
NOTE: Any change in a user's permissions in must be reflected in the service account assigned to the user. |
Run
jobsEvery
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.Data access
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
.