Access control

This page describes Identity and Access Management (IAM) roles and permissions used by Cloud Monitoring. This page is intended for administrators who configure and grant roles and permissions.

VPC Service Controls

For further control access to monitoring data, use VPC Service Controls in addition to IAM.

VPC Service Controls provides additional security for Cloud Monitoring to help mitigate the risk of data exfiltration. Using VPC Service Controls, you can add a modify a metrics scope or create and modify a Workspace to a Service Perimeter that protects Cloud Monitoring resources and services from requests originating outside the perimeter.

To learn more about Service Perimeters, see the VPC Service Controls Service Perimeter configuration documentation.

For information about Monitoring's support for VPC Service Controls, including known limitations, see the Monitoring VPC Service Controls documentation.

Monitoring IAM Overview

To use Monitoring, you must have the appropriate IAM permissions.

In general, each REST method in an API has an associated permission, and you must have the permission to use the corresponding method. Permissions aren't granted directly to users; permissions are instead granted indirectly through roles, which group multiple permissions to make managing them easier. For more information on these concepts, see Concepts related to access management.

Roles for common combinations of permissions are predefined for you, but it's also possible to create your own combinations of permissions by creating IAM custom roles.

Predefined roles

The following IAM roles are predefined by Cloud Monitoring. They grant permissions only for Monitoring.

Monitoring

The following roles grant general permissions for Monitoring:

Name Title	Description
`roles/monitoring.viewer`^† Monitoring Viewer^†	Gives you read-only access to Monitoring in the Google Cloud Console and API.
`roles/monitoring.editor` Monitoring Editor	Gives you read-write access to Monitoring in the Google Cloud Console and API, and lets you modify a metrics scope or create and modify a Workspace.
`roles/monitoring.admin` Monitoring Admin	Gives you full access to Monitoring in the Google Cloud Console and lets you modify a metrics scope or create and modify a Workspace.

^† For the hybrid and metrics scope data models, this role is sufficient to access Cloud Monitoring. For the Workspace data model, this role is sufficient to access an existing Workspace.

The following role is used by service accounts for write-only access:

Name Title	Description
`roles/monitoring.metricWriter` Monitoring Metric Writer	Permits writing monitoring data to a metrics scope or a Workspace; doesn't permit access to Monitoring in the Google Cloud Console. For service accounts.

Alert policies

The following roles grant permissions only for alert policies:

Name Title	Description
`roles/monitoring.alertPolicyViewer` Monitoring AlertPolicy Viewer	Gives you read-only access to alert policies.
`roles/monitoring.alertPolicyEditor` Monitoring AlertPolicy Editor	Gives you read-write access to alert policies.

Dashboards

The following roles grant permissions only for dashboards:

Name Title	Description
`roles/monitoring.dashboardViewer` Monitoring Dashboard Configuration Viewer	Gives you read-only access to dashboard configurations.
`roles/monitoring.dashboardEditor` Monitoring Dashboard Configuration Editor	Gives you read-write access to dashboard configurations.

Notification channels

The following roles grant permissions only for notification channels:

Name Title	Description
`roles/monitoring.notificationChannelViewer` Monitoring NotificationChannel Viewer	Gives you read-only access to notification channels.
`roles/monitoring.notificationChannelEditor` Monitoring NotificationChannel Editor	Gives you read-write access to notification channels.

Service monitoring

The following roles grant permissions for managing services:

Name Title	Description
`roles/monitoring.servicesViewer` Monitoring Services Viewer	Gives you read-only access to services.
`roles/monitoring.servicesEditor` Monitoring Services Editor	Gives you read-write access to services.

For more information on service monitoring, see SLO monitoring.

Uptime-check configurations

The following roles grant permissions only for uptime-check configurations:

Name Title	Description
`roles/monitoring.uptimeCheckConfigViewer` Monitoring Uptime Check Configurations Viewer	Gives you read-only access to uptime-check configurations.
`roles/monitoring.uptimeCheckConfigEditor` Monitoring Uptime Check Configurations Editor	Gives you read-write access to uptime-check configurations.

Metrics scope and Workspace configurations

To manage a metrics scope, or to create or manage a Workspace, you must use the Google Cloud Console. For information about the roles needed to modify a metrics scope or create and modify a Workspace, see predefined Monitoring roles.

Google Cloud

The following roles grant permissions for many services and resources in Google Cloud, including Monitoring:

Name Title	Includes permissions
`roles/viewer` Viewer	The Monitoring permissions are exactly the permissions in `roles/monitoring.viewer`.
`roles/editor` Editor	The Monitoring permissions are the same as those in `roles/monitoring.editor`.
`roles/owner` Owner	The Monitoring permissions are the same as those in `roles/editor`.

Custom roles

You can also create your own custom roles that contain lists of permissions. For more details about roles and permissions, go to Permissions and roles and Custom roles on this page.

Permissions and roles

This section lists the IAM permissions and roles that apply to Monitoring.

API permissions

Each Monitoring API method requires a specific IAM permission, as listed in the following table.

Monitoring API method	Permission	Resource type
`projects.alertPolicies.create`	`monitoring.alertPolicies.create`	project¹
`projects.alertPolicies.delete`	`monitoring.alertPolicies.delete`	`AlertPolicy`
`projects.alertPolicies.get`	`monitoring.alertPolicies.get`	`AlertPolicy`
`projects.alertPolicies.list`	`monitoring.alertPolicies.list`	project¹
`projects.alertPolicies.patch`	`monitoring.alertPolicies.update`	`AlertPolicy`
`projects.dashboards.create`	`monitoring.dashboards.create`	project¹
`projects.dashboards.delete`	`monitoring.dashboards.delete`	project¹
`projects.dashboards.get`	`monitoring.dashboards.get`	project¹
`projects.dashboards.list`	`monitoring.dashboards.list`	project¹
`projects.dashboards.patch`	`monitoring.dashboards.update`	project¹
`projects.groups.create`	`monitoring.groups.create`	project¹
`projects.groups.delete`	`monitoring.groups.delete`	`Group`
`projects.groups.get`	`monitoring.groups.get`	`Group`
`projects.groups.list`	`monitoring.groups.list`	project¹
`projects.groups.update`	`monitoring.groups.update`	`Group`
`projects.groups.members.list`	`monitoring.groups.get`	`Group`
`projects.metricDescriptors.create`	`monitoring.metricDescriptors.create`	project
`projects.metricDescriptors.delete`	`monitoring.metricDescriptors.delete`	`MetricDescriptor`
`projects.metricDescriptors.get`	`monitoring.metricDescriptors.get`	`MetricDescriptor`
`projects.metricDescriptors.list`	`monitoring.metricDescriptors.list`	project
`projects.monitoredResourceDescriptors.get`	`monitoring.monitoredResourceDescriptors.get`	`MonitoredResourceDescriptor`
`projects.monitoredResourceDescriptors.list`	`monitoring.monitoredResourceDescriptors.list`	project
`projects.notificationChannelDescriptors.get`	`monitoring.notificationChannelDescriptors.get`	`NotificationChannelDescriptor`
`projects.notificationChannelDescriptors.list`	`monitoring.notificationChannelDescriptors.list`	project¹
`projects.notificationChannels.create`	`monitoring.notificationChannels.create`	project¹
`projects.notificationChannels.delete`	`monitoring.notificationChannels.delete`	`NotificationChannel`
`projects.notificationChannels.get`	`monitoring.notificationChannels.get`	`NotificationChannel`
`projects.notificationChannels.getVerificationCode`	`monitoring.notificationChannels.getVerificationCode`	`NotificationChannel`
`projects.notificationChannels.list`	`monitoring.notificationChannels.list`	project¹
`projects.notificationChannels.patch`	`monitoring.notificationChannels.update`	`NotificationChannel`
`projects.notificationChannels.sendVerificationCode`	`monitoring.notificationChannels.sendVerificationCode`	`NotificationChannel`
`projects.notificationChannels.verify`	`monitoring.notificationChannels.verify`	`NotificationChannel`
`projects.services.create`	`monitoring.services.create`	project¹
`projects.services.delete`	`monitoring.services.delete`	`Service`
`projects.services.get`	`monitoring.services.get`	`Service`
`projects.services.list`	`monitoring.services.list`	project¹
`projects.services.patch`	`monitoring.services.update`	`Service`
`projects.services.serviceLevelObjectives.create`	`monitoring.slos.create`	project¹
`projects.services.serviceLevelObjectives.delete`	`monitoring.slos.delete`	`ServiceLevelObjective`
`projects.services.serviceLevelObjectives.get`	`monitoring.slos.get`	`ServiceLevelObjective`
`projects.services.serviceLevelObjectives.list`	`monitoring.slos.list`	project¹
`projects.services.serviceLevelObjectives.patch`	`monitoring.slos.update`	`ServiceLevelObjective`
`projects.timeSeries.create`	`monitoring.timeSeries.create`	project
`projects.timeSeries.list`	`monitoring.timeSeries.list`	project, folder, organization
`projects.timeSeries.query`	`monitoring.timeSeries.list`	project
`projects.uptimeCheckConfigs.create`	`monitoring.uptimeCheckConfigs.create`	`UptimeCheckConfig`
`projects.uptimeCheckConfigs.delete`	`monitoring.uptimeCheckConfigs.delete`	`UptimeCheckConfig`
`projects.uptimeCheckConfigs.get`	`monitoring.uptimeCheckConfigs.get`	`UptimeCheckConfig`
`projects.uptimeCheckConfigs.list`	`monitoring.uptimeCheckConfigs.list`	`UptimeCheckConfig`
`projects.uptimeCheckConfigs.patch`	`monitoring.uptimeCheckConfigs.update`	`UptimeCheckConfig`

¹ For the Workspace data model, the project must be in a Workspace.

Console permissions for Monitoring

Each feature of Monitoring in the Google Cloud Console requires that you have the permission for the API used to implement the feature. For example, the ability to browse groups requires that you have permission for the list and get methods applicable to groups and group members. You might lose functionality if required permissions are revoked.

The following table lists the permissions required to use the Monitoring in the Google Cloud Console:

Activity	Required permissions	For resource type
Full read-only access	The set of permissions included in the `roles/monitoring.viewer` role	project¹.
Read-write access console	The set of permissions included in the `roles/monitoring.editor` role	project¹.
Full access to the console	The set of permissions included in the `roles/monitoring.admin` role	project¹.

¹ For the Workspace data model, the project must be in a Workspace.

Roles

The following table lists the IAM roles that grant access to Monitoring and the permissions associated with each role. Several of these roles are graduated: for example, the roles/monitoring.editor role includes all the permissions of the roles/monitoring.viewer role, plus an additional set of permissions.

Roles can be assigned at the project level only.

Monitoring

The Monitoring roles include these permissions:

Name Title	Includes permissions
`roles/monitoring.viewer` Monitoring Viewer	`cloudnotifications.activities.list` `monitoring.alertPolicies.get` `monitoring.alertPolicies.list` `monitoring.dashboards.get` `monitoring.dashboards.list` `monitoring.groups.get` `monitoring.groups.list` `monitoring.metricDescriptors.get` `monitoring.metricDescriptors.list` `monitoring.monitoredResourceDescriptors.get` `monitoring.monitoredResourceDescriptors.list` `monitoring.notificationChannelDescriptors.get` `monitoring.notificationChannelDescriptors.list` `monitoring.notificationChannels.get` `monitoring.notificationChannels.list` `monitoring.publicWidgets.get` `monitoring.publicWidgets.list` `monitoring.services.get` `monitoring.services.list` `monitoring.slos.get` `monitoring.slos.list` `monitoring.timeSeries.list` `monitoring.uptimeCheckConfigs.get` `monitoring.uptimeCheckConfigs.list` `resourcemanager.projects.get` `resourcemanager.projects.list` `stackdriver.projects.get`
`roles/monitoring.editor` Monitoring Editor	`cloudnotifications.activities.list` `monitoring.alertPolicies.create` `monitoring.alertPolicies.delete` `monitoring.alertPolicies.get` `monitoring.alertPolicies.list` `monitoring.alertPolicies.update` `monitoring.dashboards.create` `monitoring.dashboards.delete` `monitoring.dashboards.get` `monitoring.dashboards.list` `monitoring.dashboards.update` `monitoring.groups.create` `monitoring.groups.delete` `monitoring.groups.get` `monitoring.groups.list` `monitoring.groups.update` `monitoring.metricDescriptors.create` `monitoring.metricDescriptors.delete` `monitoring.metricDescriptors.get` `monitoring.metricDescriptors.list` `monitoring.monitoredResourceDescriptors.get` `monitoring.monitoredResourceDescriptors.list` `monitoring.notificationChannelDescriptors.list` `monitoring.notificationChannelDescriptors.get` `monitoring.notificationChannels.create` `monitoring.notificationChannels.delete` `monitoring.notificationChannels.get` `monitoring.notificationChannels.list` `monitoring.notificationChannels.sendVerificationCode` `monitoring.notificationChannels.update` `monitoring.notificationChannels.verify` `monitoring.publicWidgets.create` `monitoring.publicWidgets.delete` `monitoring.publicWidgets.get` `monitoring.publicWidgets.list` `monitoring.publicWidgets.update` `monitoring.services.create` `monitoring.services.delete` `monitoring.services.get` `monitoring.services.list` `monitoring.services.update` `monitoring.slos.create` `monitoring.slos.delete` `monitoring.slos.get` `monitoring.slos.list` `monitoring.slos.update` `monitoring.timeSeries.create` `monitoring.timeSeries.list` `monitoring.uptimeCheckConfigs.create` `monitoring.uptimeCheckConfigs.delete` `monitoring.uptimeCheckConfigs.get` `monitoring.uptimeCheckConfigs.list` `monitoring.uptimeCheckConfigs.update` `opsconfigmonitoring.resourceMetadata.write` `opsconfigmonitoring.resourceSnapshot.create` `resourcemanager.projects.get` `resourcemanager.projects.list` `serviceusage.services.enable` `stackdriver.projects.edit` `stackdriver.projects.get` `stackdriver.resourceMetadata.write`
`roles/monitoring.admin` Monitoring Admin	The permissions in `roles/monitoring.editor`, plus the following: `monitoring.notificationChannels.getVerificationCode`

The following role is used by service accounts for write-only access:

Name Title	Includes permissions
`roles/monitoring.metricWriter` Monitoring Metric Writer	`monitoring.metricDescriptors.create` `monitoring.metricDescriptors.get` `monitoring.metricDescriptors.list` `monitoring.monitoredResourceDescriptors.get` `monitoring.monitoredResourceDescriptors.list` `monitoring.timeSeries.create`

Alert policies

The Alert policy roles include these permissions:

Name Title	Includes permissions
`roles/monitoring.alertPolicyViewer` Monitoring AlertPolicy Viewer	`monitoring.alertPolicies.get` `monitoring.alertPolicies.list`
`roles/monitoring.alertPolicyEditor` Monitoring AlertPolicy Editor	`monitoring.alertPolicies.create` `monitoring.alertPolicies.delete` `monitoring.alertPolicies.get` `monitoring.alertPolicies.list` `monitoring.alertPolicies.update`

Dashboards

The Dashboards roles include these permissions:

Name Title	Includes permissions
`roles/monitoring.dashboardViewer` Monitoring Dashboard Configuration Viewer	`monitoring.dashboards.get` `monitoring.dashboards.list`
`roles/monitoring.dashboardEditor` Monitoring Dashboard Configuration Editor	`monitoring.dashboards.get` `monitoring.dashboards.list` `monitoring.dashboards.create` `monitoring.dashboards.delete` `monitoring.dashboards.update`

Notification channels

The Notification channels roles include these permissions:

Name Title	Includes permissions
`roles/monitoring.notificationChannelViewer` Monitoring NotificationChannel Viewer	`monitoring.notificationChannelDescriptors.get` `monitoring.notificationChannelDescriptors.list` `monitoring.notificationChannels.get` `monitoring.notificationChannels.list`
`roles/monitoring.notificationChannelEditor` Monitoring NotificationChannel Editor	`monitoring.notificationChannelDescriptors.get` `monitoring.notificationChannelDescriptors.list` `monitoring.notificationChannels.create` `monitoring.notificationChannels.delete` `monitoring.notificationChannels.get` `monitoring.notificationChannels.list` `monitoring.notificationChannels.sendVerificationCode` `monitoring.notificationChannels.update` `monitoring.notificationChannels.verify`

Service monitoring

The Service monitoring roles include these permissions:

Name Title	Includes permissions
`roles/monitoring.servicesViewer` Monitoring Services Viewer	`monitoring.services.get` `monitoring.services.list` `monitoring.slos.get` `monitoring.slos.list`
`roles/monitoring.servicesEditor` Monitoring Services Editor	`monitoring.services.create` `monitoring.services.delete` `monitoring.services.get` `monitoring.services.list` `monitoring.services.update` `monitoring.slos.create` `monitoring.slos.delete` `monitoring.slos.get` `monitoring.slos.list` `monitoring.slos.update`

Uptime-check configurations

The Uptime-check configuration roles include these permissions:

Name Title	Includes permissions
`roles/monitoring.uptimeCheckConfigViewer` Monitoring Uptime Check Configurations Viewer	`monitoring.uptimeCheckConfigs.get` `monitoring.uptimeCheckConfigs.list`
`roles/monitoring.uptimeCheckConfigEditor` Monitoring Uptime Check Configurations Editor	`monitoring.uptimeCheckConfigs.create` `monitoring.uptimeCheckConfigs.delete` `monitoring.uptimeCheckConfigs.get` `monitoring.uptimeCheckConfigs.list` `monitoring.uptimeCheckConfigs.update`

Metrics scope and Workspace configurations

Google Cloud

The Google Cloud roles include these permissions:

Name Title	Includes permissions
`roles/viewer` Viewer	The Monitoring permissions are exactly the permissions in `roles/monitoring.viewer`.
`roles/editor` Editor	The Monitoring permissions are the same as those in `roles/monitoring.editor`.
`roles/owner` Owner	The Monitoring permissions are the same as those in `roles/editor`.

Granting IAM roles

The project owners, editors, and default service accounts for Compute Engine and App Engine have the necessary permissions already; however, for other user accounts, you might need to grant these roles explicitly.

For example, in order for a user account to read or write metric descriptors by using the Monitoring API, that user must have the appropriate monitoring.metricDescriptors.* IAM permissions. These can be provided by granting the predefined Monitoring Viewer (roles/monitoring.viewer) and Monitoring Editor (roles/monitoring.editor) roles. For more information, go to API permissions.

These permissions can be granted either by using the Cloud SDK gcloud command-line tool or the Google Cloud Console (Cloud Console).

Cloud SDK

Use the gcloud projects add-iam-policy-binding command to grant the monitoring.viewer or monitoring.editor role.

For example:

export PROJECT_ID="my-test-project"
export EMAIL_ADDRESS="myuser@gmail.com"
gcloud projects add-iam-policy-binding \
      $PROJECT_ID \
      --member="user:$EMAIL_ADDRESS" \
      --role="roles/monitoring.editor"

You can confirm the granted roles using the gcloud projects get-iam-policy command:

export PROJECT_ID="my-test-project"
gcloud projects get-iam-policy $PROJECT_ID

Cloud Console

Go to the Cloud Console:

Go to the Cloud Console
If necessary, click the drop-down list of Google Cloud projects and select the name of the project where you want to enable the API.
To expand the navigation menu, click Menu .
Click IAM & admin.
If the user is a member, click Edit to modify their permissions. You can modify the existing role or add an additional role. To save your changes, click Save.
If the user isn't a member, do the following:
1. Click Add.
2. Enter the user name in the New members text box.
3. In Select a role, click menu .
4. In the filter bar , enter the appropriate role:
  - Monitoring Editor grants read-write access.
  - Monitoring Viewer grants read-only access.

Custom roles

To create a custom role with Monitoring permissions, do the following:

For a role granting permissions only for the Monitoring API, choose from the permissions in the API permissions section.
For a role granting permissions for Monitoring in the Google Cloud Console, choose from permission groups in the Console permissions for Monitoring section.
To grant the ability to write monitoring data, include the permissions from the role roles/monitoring.metricWriter in the Roles section.

For more information on custom roles, go to Understanding IAM custom roles.

Compute Engine access scopes

Access scopes are the legacy method of specifying permissions for your Compute Engine VM instances. The following access scopes apply to Monitoring:

Access scope	Permissions granted
https://www.googleapis.com/auth/monitoring.read	The same permissions as in `roles/monitoring.viewer`.
https://www.googleapis.com/auth/monitoring.write	The same permissions as in `roles/monitoring.metricWriter`.
https://www.googleapis.com/auth/monitoring	Full access to Monitoring.
https://www.googleapis.com/auth/cloud-platform	Full access to all enabled Cloud APIs.

For more details, go to Access scopes.

Best practice. Because service account IAM roles are easy to configure and change, a good practice is to give your VM instances the most powerful access scope (cloud-platform) and then use IAM roles to restrict access to specific APIs and operations. For details, go to Service account permissions.