You can share the assets or compute quota of your Earth Engine enabled project with other Earth Engine users at the project level. Earth Engine assets or compute can be shared with another user or group of users. If you want to share with a group of users, Create a new Google Group and note its email (available from the About link on the group page). This page describes how to provide access to resources, for either an individual or group and the Roles and Permissions required for different activities.
Set Earth Engine service usage
To use the Earth Engine API on a Cloud project, the API must be enabled on the
project
, and the user must have at least the
permissions in the Earth Engine Resource Viewer
role (learn more about predefined Earth Engine IAM Roles
).
Additionally, the user must have at least serviceusage.services.use
permission
on the project. That permission can be provided through the project Owner
or Editor
roles, or through the specific Service Usage Consumer
role
. An
error will be thrown if the user does not have required Earth Engine permissions
and Service Usage permissions on the selected project.
Set asset permissions
Set asset-level permissions
There are several options to update permissions at the asset level.
- Use the Assets Manager in the Code Editor.
- Use the Earth Engine command line.
- Use a client library, for example,
ee.data.setAssetAcl()
. - Or call the REST API directly.
Set project-level asset permissions
Sharing at the project level sets permissions on all assets in your Earth Engine enabled Cloud project at once.
You can share assets at the project level by assigning the appropriate Identity and Access Management (IAM) role on your project's IAM admin page. There are Predefined Earth Engine IAM Roles for sharing Earth Engine assets and resources. See Understanding Roles for a more general overview of IAM roles.
When another user attempts to access one of your assets, permissions are first checked at the asset level. If permissions have not been set at the asset level or the check fails (i.e., no access), permissions will be checked at the project level.
Set project level permissions
To set permissions at the project level, assign a project IAM role to a user or group of users:
- Open the IAM page in the Google Cloud console
Open the IAM Page
Or hold the pointer over your project name on the Assetstab of the Code Editor and click the icon. - Click select a projectand choose your project (you should already be there if you opened the IAM page from the Code Editor).
- Click ADDat the top and add the individual or group email as the new member, or click the icon next to the existing member in the project.
- In the Roledrop down search for the Earth Engine Resource role you want to grant. See Predefined Earth Engine IAM Roles for details.
- Click the SAVEbutton.
VPC Service Controls
Earth Engine supports VPC Service Controls , a Google Cloud security feature which helps users secure their resources and mitigate data exfiltration risk. Adding resources to a VPC service perimeter allow for more control over data read and write operations.
Learn more about VPC-SC features and configuration .
Limitations
Enabling VPC Service Controls for your resources comes with a few limitations, for which we provided example workarounds:
- Use other available export destinations like Google Cloud Storage and BigQuery .
- Save your resources in Earth Engine by exporting raster or tabular data to assets.
Using Earth Engine with resources inside a secured VPC service perimeter is only available for Professional and Premium pricing plans. Trying to use Earth Engine API with a VPC-SC secured project associated with a Basic pricing plan will result in an error. To learn more about Earth Engine pricing visit official documentation .
More information about VPC Service Controls and its limitations can be found in Supported products and limitations .
Roles and permissions
The following sections describe the permissions and roles required to perform activities and access Earth Engine resources. See the Google Cloud documentation to learn more about Cloud project permissions and roles .
Predefined Earth Engine IAM Roles
Earth Engine provides predefined roles which allow varying degrees of control over Earth Engine resources within a project. These roles are:
Role | Title | Description |
---|---|---|
roles/earthengine.viewer
|
Earth Engine Resource Viewer | Provides permission to view and list Assets and tasks. |
roles/earthengine.writer
|
Earth Engine Resource Writer | Provides permission to read, create, modify and delete assets, import images and tables, read and update tasks, perform interactive computations, and create long running export tasks. |
roles/earthengine.admin
|
Earth Engine Admin | Provides permission for all Earth Engine resources including changing access controls for Earth Engine assets. |
roles/earthengine.appsPublisher
|
Earth Engine Apps Publisher | Provides permission to create a service account for use with an Earth Engine app. Also grants permission to edit and delete Project-owned apps under the Cloud Project. |
Note that you may set a primitive or custom role if the predefined Earth Engine roles don't meet your needs. You can see the bundle of permissions associated with each role from the IAM Roles page by filtering to a specific role and clicking on the role.
Full access to the Earth Engine API
To give users full access to the Earth Engine service, either through the REST API directly, through the Code Editor or through a client library, users will need permission to perform operations like:
- Executing Earth Engine expressions
- Running batch computations (exports)
- Getting interactive results (online maps, thumbnails, charts, etc.)
- Creating/deleting Earth Engine assets
- Using OAuth Authentication via a Client Library to connect to Earth Engine
-
clientauthconfig.clients.listWithSecrets
-
earthengine.assets.get
-
earthengine.assets.getIamPolicy
-
earthengine.assets.list
-
earthengine.computations.create
-
earthengine.operations.get
-
earthengine.operations.list
-
monitoring.timeSeries.list
-
resourcemanager.projects.get
-
resourcemanager.projects.list
-
serviceusage.operations.get
-
serviceusage.operations.list
-
serviceusage.quotas.get
-
serviceusage.services.get
-
serviceusage.services.list
-
serviceusage.services.use
- Service Usage Consumer
(
roles/serviceusage.serviceUsageConsumer
) AND one of: - Earth Engine Resource Viewer
(
roles/earthengine.viewer
) OR - Earth Engine Resource Writer
(
roles/earthengine.writer
) OR - Earth Engine Resource Admin
(
roles/earthengine.admin
) - OAuth Config Editor
(
roles/oauthconfig.editor
) is additionally required for users who access Earth Engine through a notebook environment and use the Notebook Authenticator. See Colab or JupyterLab notebook authentication for more details.
ee.Initialize(project=X)
Asset sharing only
Grant the user one of the Predefined Earth Engine IAM
Roles
with minimal permissions to perform the needed activity. Note that users won't
be able to consume project resources without necessary serviceusage
permissions.
Project management
List and display available projects
This happens when using the Code Editor to browse available projects.
-
resourcemanager.projects.get
-
resourcemanager.folders.list
-
resourcemanager.folders.get
-
resourcemanager.organizations.get
(uncommon)
- Viewer
(
roles/viewer
) OR
Earth Engine Resource Viewer (roles/earthengine.viewer
) on relevant projects OR
Browser (roles/browser
, recommended for advanced organization cases) - Folder Viewer
(
roles/resourcemanager.folderViewer
) on relevant folders
Select a project for use in the Code Editor
-
resourcemanager.projects.get
-
serviceusage.services.get
If project has not previously been set up
On first selecting a project through the Code Editor, the project is initialized for use with Earth Engine. If this hasn't been done before, you will need these roles for setup to succeed.
-
resourcemanager.projects.update
AND -
serviceusage.services.enable
- Viewer
(
roles/viewer
) OR - Earth Engine Resource Viewer
(
roles/earthengine.viewer
) AND
Service Usage Consumer (roles/serviceusage.serviceUsageConsumer
)
Additional roles (if project has not previously been set up)
- Editor
(
roles/editor
) OR - Project Mover
(
roles/resourcemanager.projectMover
) AND
Project IAM Admin (roles/resourcemanager.projectIamAdmin
) AND
Service Usage Admin (roles/serviceusage.serviceUsageAdmin
)
Create project through the Code Editor
-
resourcemanager.projects.get
-
resourcemanager.projects.create
-
resourcemanager.projects.update
-
serviceusage.services.get
-
serviceusage.services.enable
- Editor
(
roles/editor
) OR - Project Mover
(
roles/resourcemanager.projectMover
) AND
Project Creator (roles/resourcemanager.projectCreator
) AND
Service Usage Admin (roles/serviceusage.serviceUsageAdmin
)
projects.update
permission.Commercial Project Registration
The following permissions pertain to registering projects for paid use .
-
billing.subscriptions.list
-
billing.accounts.get
(for creating a new Limited plan) -
billing.subscriptions.create
(for creating a new Basic or Professional plan)
-
earthengine.computations.create
-
earthengine.config.update
-
serviceusage.services.get
-
serviceusage.services.enable
- Billing Account Viewer
(
roles/billing.viewer
), for creating a new Limited plan - Billing Account Administrator
(
roles/billing.admin
), for creating a new Basic or Professional plan
- Earth Engine Resource Writer
(
roles/earthengine.writer
) - Service Usage Admin
(
roles/serviceusage.serviceUsageAdmin
)
Commercial Earth Engine plan management
The following permissions pertain to managing Earth Engine pricing plans .
on the billing account
-
billing.subscriptions.create
(to change an Earth Engine plan) -
billing.subscriptions.list
(to view the current Earth Engine plan)
on the billing account
- Billing Account Viewer
(
roles/billing.viewer
), to view the current Earth Engine plan - Billing Account Administrator
(
roles/billing.admin
), to change an Earth Engine plan
Batch task management
The following permissions pertain to configuring per-project limits on batch task concurrency . This feature is only available for commercial users of Earth Engine.
Viewing project-level batch task limits
on the Cloud account
earthengine.config.get
Setting project-level batch task limits
Permissions needed on the Cloud account |
earthengine.config.update
Note: This permission also encompasses viewing the plan-level limits that are configured on the billing account. |
Permissions needed on the billing account |
billing.subscriptions.list
|
Apps management
Display app info
-
iam.serviceAccounts.get
-
iam.serviceAccounts.getIamPolicy
, if app is restricted (less common)
roles/viewer
) OREarth Engine Apps Publisher (
roles/earthengine.appsPublisher
)Publish/Update app
-
iam.serviceAccounts.get
-
iam.serviceAccounts.create
-
iam.serviceAccounts.enable
-
iam.serviceAccounts.getIamPolicy
-
iam.serviceAccounts.setIamPolicy
-
iam.serviceAccounts.disable
, if app is moved from one project to another (uncommon)
roles/earthengine.appsPublisher
) ORService Account Admin (
roles/iam.serviceAccountAdmin
)- In addition, Earth Engine App service accounts identify themselves
to the Earth Engine servers by presenting an OAuth access token.
Therefore, certain identities are added during app creation as Service Account Token Creator
(
roles/iam.serviceAccountTokenCreator
- In the case of a public Earth Engine App, the identity granted that
role is
earth-engine-public-apps@appspot.gserviceaccount.com
Delete and app
Permissions needed | iam.serviceAccounts.disable
|
Suggested roles | Earth Engine Apps Publisher
( roles/earthengine.appsPublisher
) ORService Account Admin ( roles/iam.serviceAccountAdmin
) |