Menu
Grafana Cloud Enterprise

RBAC permissions, actions, and scopes

Note

Available in Grafana Enterprise and Grafana Cloud.

A permission is comprised of an action and a scope. When creating a custom role, consider the actions the user can perform and the resource(s) on which they can perform those actions.

To learn more about the Grafana resources to which you can apply RBAC, refer to Resources with RBAC permissions.

  • Action: An action describes what tasks a user can perform on a resource.
  • Scope: A scope describes where an action can be performed, such as reading a specific user profile. In this example, a permission is associated with the scope users:<userId> to the relevant role.

Action definitions

The following list contains role-based access control actions.

ActionApplicable scopeDescription
alert.instances.external:readdatasources:*
datasources:uid:*
Read alerts and silences in data sources that support alerting.
alert.instances.external:writedatasources:*
datasources:uid:*
Manage alerts and silences in data sources that support alerting.
alert.instances:createn/aCreate silences in the current organization.
alert.instances:readn/aRead alerts and silences in the current organization.
alert.instances:writen/aUpdate and expire silences in the current organization.
alert.notifications.external:readdatasources:*
datasources:uid:*
Read templates, contact points, notification policies, and mute timings in data sources that support alerting.
alert.notifications.external:writedatasources:*
datasources:uid:*
Manage templates, contact points, notification policies, and mute timings in data sources that support alerting.
alert.notifications:writen/aManage templates, contact points, notification policies, and mute timings in the current organization.
alert.notifications:readn/aRead all templates, contact points, notification policies, and mute timings in the current organization.
alert.rules.external:readdatasources:*
datasources:uid:*
Read alert rules in data sources that support alerting (Prometheus, Mimir, and Loki)
alert.rules.external:writedatasources:*
datasources:uid:*
Create, update, and delete alert rules in data sources that support alerting (Mimir and Loki).
alert.rules:createfolders:*
folders:uid:*
Create Grafana alert rules in a folder and its subfolders. Combine this permission with folders:read in a scope that includes the folder and datasources:query in the scope of data sources the user can query.
alert.rules:deletefolders:*
folders:uid:*
Delete Grafana alert rules in a folder and its subfolders. Combine this permission with folders:read in a scope that includes the folder and datasources:query in the scope of data sources the user can query.
alert.rules:readfolders:*
folders:uid:*
Read Grafana alert rules in a folder and its subfolders. Combine this permission with folders:read in a scope that includes the folder and datasources:query in the scope of data sources the user can query.
alert.rules:writefolders:*
folders:uid:*
Update Grafana alert rules in a folder and its subfolders. Combine this permission with folders:read in a scope that includes the folder and datasources:query in the scope of data sources the user can query.
alert.provisioning:readn/aRead all Grafana alert rules, notification policies, etc via provisioning API. Permissions to folders and datasource are not required.
alert.provisioning.secrets:readn/aSame as alert.provisioning:read plus ability to export resources with decrypted secrets.
alert.provisioning:writen/aUpdate all Grafana alert rules, notification policies, etc via provisioning API. Permissions to folders and datasource are not required.
annotations:createannotations:*
annotations:type:*
Create annotations.
annotations:deleteannotations:*
annotations:type:*
Delete annotations.
annotations:readannotations:*
annotations:type:*
Read annotations and annotation tags.
annotations:writeannotations:*
annotations:type:*
Update annotations.
apikeys:createn/aCreate API keys.
apikeys:readapikeys:*
apikeys:id:*
Read API keys.
apikeys:deleteapikeys:*
apikeys:id:*
Delete API keys.
dashboards:createfolders:*
folders:uid:*
Create dashboards in one or more folders and their subfolders.
dashboards:deletedashboards:*
dashboards:uid:*
folders:*
folders:uid:*
Delete one or more dashboards.
dashboards.insights:readn/aRead dashboard insights data and see presence indicators.
dashboards.permissions:readdashboards:*
dashboards:uid:*
folders:*
folders:uid:*
Read permissions for one or more dashboards.
dashboards.permissions:writedashboards:*
dashboards:uid:*
folders:*
folders:uid:*
Update permissions for one or more dashboards.
dashboards:readdashboards:*
dashboards:uid:*
folders:*
folders:uid:*
Read one or more dashboards.
dashboards:writedashboards:*
dashboards:uid:*
folders:*
folders:uid:*
Update one or more dashboards.
dashboards.public:writedashboards:*
dashboards:uid:*
Write public dashboard configuration.
datasources.caching:readdatasources:*
datasources:uid:*
Read data source query caching settings.
datasources.caching:writedatasources:*
datasources:uid:*
Update data source query caching settings.
datasources:createn/aCreate data sources.
datasources:deletedatasources:*
datasources:uid:*
Delete data sources.
datasources:exploren/aEnable access to the Explore tab.
datasources.id:readdatasources:*
datasources:uid:*
Read data source IDs.
datasources.insights:readn/aRead data sources insights data.
datasources.permissions:readdatasources:*
datasources:uid:*
List data source permissions.
datasources.permissions:writedatasources:*
datasources:uid:*
Update data source permissions.
datasources:querydatasources:*
datasources:uid:*
Query data sources.
datasources:readdatasources:*
datasources:uid:*
List data sources.
datasources:writedatasources:*
datasources:uid:*
Update data sources.
featuremgmt.readn/aRead feature toggles.
featuremgmt.writen/aWrite feature toggles.
folders.permissions:readfolders:*
folders:uid:*
Read permissions for one or more folders and their subfolders.
folders.permissions:writefolders:*
folders:uid:*
Update permissions for one or more folders and their subfolders.
folders:createn/aCreate folders in the root level. If granted together with folders:write, also allows creating subfolders under all folders that the user can update.
folders:deletefolders:*
folders:uid:*
Delete one or more folders and their subfolders.
folders:readfolders:*
folders:uid:*
Read one or more folders and their subfolders.
folders:writefolders:*
folders:uid:*
Update one or more folders and their subfolders. If granted together with folders:create permission, also allows creating subfolders under these folders.
ldap.config:reloadn/aReload the LDAP configuration.
ldap.status:readn/aVerify the availability of the LDAP server or servers.
ldap.user:readn/aRead users via LDAP.
ldap.user:syncn/aSync users via LDAP.
licensing.reports:readn/aGet custom permission reports.
licensing:deleten/aDelete the license token.
licensing:readn/aRead licensing information.
licensing:writen/aUpdate the license token.
org.users:writeusers:*
users:id:*
Update the organization role (Viewer, Editor, or Admin) of a user.
org.users:addusers:*
users:id:*
Add a user to an organization or invite a new user to an organization.
org.users:readusers:*
users:id:*
Get user profiles within an organization.
org.users:removeusers:*
users:id:*
Remove a user from an organization.
orgs.preferences:readn/aRead organization preferences.
orgs.preferences:writen/aUpdate organization preferences.
orgs.quotas:readn/aRead organization quotas.
orgs.quotas:writen/aUpdate organization quotas.
orgs:createn/aCreate an organization.
orgs:deleten/aDelete one or more organizations.
orgs:readn/aRead one or more organizations.
orgs:writen/aUpdate one or more organizations.
plugins.app:accessplugins:*
plugins:id:*
Access one or more application plugins (still enforcing the organization role)
plugins:installn/aInstall and uninstall plugins.
plugins:writeplugins:*
plugins:id:*
Edit settings for one or more plugins.
provisioning:reloadprovisioners:*Reload provisioning files. To find the exact scope for specific provisioner, see Scope definitions.
reports:createn/aCreate reports.
reports:writereports:*
reports:id:*
Update reports.
reports.settings:readn/aRead report settings.
reports.settings:writen/aUpdate report settings.
reports:deletereports:*
reports:id:*
Delete reports.
reports:readreports:*
reports:id:*
List all available reports or get a specific report.
reports:sendreports:*
reports:id:*
Send a report email.
roles:deletepermissions:type:delegateDelete a custom role.
roles:readroles:*
roles:uid:*
List roles and read a specific with its permissions.
roles:writepermissions:type:delegateCreate or update a custom role.
roles:writepermissions:type:escalateReset basic roles to their default permissions.
server.stats:readn/aRead Grafana instance statistics.
server.usagestats.report:readn/aView usage statistics report.
serviceaccounts:writeserviceaccounts:*Create Grafana service accounts.
serviceaccounts:createn/aUpdate Grafana service accounts.
serviceaccounts:deleteserviceaccounts:*
serviceaccounts:id:*
Delete Grafana service accounts.
serviceaccounts:readserviceaccounts:*
serviceaccounts:id:*
Read Grafana service accounts.
serviceaccounts.permissions:writeserviceaccounts:*
serviceaccounts:id:*
Update Grafana service account permissions to control who can do what with the service account.
serviceaccounts.permissions:readserviceaccounts:*
serviceaccounts:id:*
Read Grafana service account permissions to see who can do what with the service account.
settings:readsettings:*
settings:auth.saml:*
settings:auth.saml:enabled (property level)
Read the Grafana configuration settings
settings:writesettings:*
settings:auth.saml:*
settings:auth.saml:enabled (property level)
Update any Grafana configuration settings that can be updated at runtime.
support.bundles:createn/aCreate support bundles.
support.bundles:deleten/aDelete support bundles.
support.bundles:readn/aList and download support bundles.
status:accesscontrolservices:accesscontrolGet access-control enabled status.
teams.permissions:readteams:*
teams:id:*
Read members and Team Sync setup for teams.
teams.permissions:writeteams:*
teams:id:*
Add, remove and update members and manage Team Sync setup for teams.
teams.roles:addpermissions:type:delegateAssign a role to a team.
teams.roles:readteams:*
teams:id:*
List roles assigned directly to a team.
teams.roles:removepermissions:type:delegateUnassign a role from a team.
teams:createn/aCreate teams.
teams:deleteteams:*
teams:id:*
Delete one or more teams.
teams:readteams:*
teams:id:*
Read one or more teams and team preferences.
teams:writeteams:*
teams:id:*
Update one or more teams and team preferences.
users.authtoken:readglobal.users:*
global.users:id:*
List authentication tokens that are assigned to a user.
users.authtoken:writeglobal.users:*
global.users:id:*
Update authentication tokens that are assigned to a user.
users.password:writeglobal.users:*
global.users:id:*
Update a user’s password.
users.permissions:readusers:*List permissions of a user.
users.permissions:writeglobal.users:*
global.users:id:*
Update a user’s organization-level permissions.
users.quotas:readglobal.users:*
global.users:id:*
List a user’s quotas.
users.quotas:writeglobal.users:*
global.users:id:*
Update a user’s quotas.
users.roles:addpermissions:type:delegateAssign a role to a user or a service account.
users.roles:readusers:*List roles assigned directly to a user or a service account.
users.roles:removepermissions:type:delegateUnassign a role from a user or a service account.
users:createn/aCreate a user.
users:deleteglobal.users:*
global.users:id:*
Delete a user.
users:disableglobal.users:*
global.users:id:*
Disable a user.
users:enableglobal.users:*
global.users:id:*
Enable a user.
users:logoutglobal.users:*
global.users:id:*
Sign out a user.
users:readglobal.users:*Read or search user profiles.
users:writeglobal.users:*
global.users:id:*
Update a user’s profile.

Grafana OnCall action definitions (beta)

Note: Available from Grafana 9.4 in early access.

Note: This feature is behind the accessControlOnCall feature toggle. You can enable feature toggles through configuration file or environment variables. See configuration docs for details.

The following list contains role-based access control actions used by Grafana OnCall application plugin.

ActionApplicable scopeDescription
grafana-oncall-app.alert-groups:readn/aRead OnCall alert groups.
grafana-oncall-app.alert-groups:writen/aCreate, edit and delete OnCall alert groups.
grafana-oncall-app.integrations:readn/aRead OnCall integrations.
grafana-oncall-app.integrations:writen/aCreate, edit and delete OnCall integrations.
grafana-oncall-app.integrations:testn/aTest OnCall integrations.
grafana-oncall-app.escalation-chains:readn/aRead OnCall escalation chains.
grafana-oncall-app.escalation-chains:writen/aCreate, edit and delete OnCall escalation chains.
grafana-oncall-app.schedules:readn/aRead OnCall schedules.
grafana-oncall-app.schedules:writen/aCreate, edit and delete OnCall schedules.
grafana-oncall-app.schedules:exportn/aExport OnCall schedules.
grafana-oncall-app.chatops:readn/aRead OnCall ChatOps.
grafana-oncall-app.chatops:writen/aEdit OnCall ChatOps.
grafana-oncall-app.chatops:update-settingsn/aEdit OnCall ChatOps settings.
grafana-oncall-app.maintenance:readn/aRead OnCall maintenance.
grafana-oncall-app.maintenance:writen/aEdit OnCall maintenance.
grafana-oncall-app.api-keys:readn/aRead OnCall API keys.
grafana-oncall-app.api-keys:writen/aCreate, edit and delete OnCall API keys.
grafana-oncall-app.notifications:readn/aReceive OnCall notifications.
grafana-oncall-app.notification-settings:readn/aRead OnCall notification settings.
grafana-oncall-app.notification-settings:writen/aEdit OnCall notification settings.
grafana-oncall-app.user-settings:readn/aRead user’s own OnCall user settings.
grafana-oncall-app.user-settings:writen/aEdit user’s own OnCall user settings.
grafana-oncall-app.user-settings:adminn/aRead and edit all users’ OnCall user settings.
grafana-oncall-app.other-settings:readn/aRead OnCall settings.
grafana-oncall-app.other-settings:writen/aEdit OnCall settings.

Scope definitions

The following list contains role-based access control scopes.

ScopesDescriptions
annotations:*
annotations:type:*
Restrict an action to a set of annotations. For example, annotations:* matches any annotation, annotations:type:dashboard matches annotations associated with dashboards and annotations:type:organization matches organization annotations.
apikeys:*
apikeys:id:*
Restrict an action to a set of API keys. For example, apikeys:* matches any API key, apikey:id:1 matches the API key whose id is 1.
dashboards:*
dashboards:uid:*
Restrict an action to a set of dashboards. For example, dashboards:* matches any dashboard, and dashboards:uid:1 matches the dashboard whose UID is 1.
datasources:*
datasources:uid:*
Restrict an action to a set of data sources. For example, datasources:* matches any data source, and datasources:uid:1 matches the data source whose UID is 1.
folders:*
folders:uid:*
Restrict an action to a set of folders. For example, folders:* matches any folder, and folders:uid:1 matches the folder whose UID is 1. Note that permissions granted to a folder cascade down to subfolders located under it
global.users:*
global.users:id:*
Restrict an action to a set of global users. For example, global.users:* matches any user and global.users:id:1 matches the user whose ID is 1.
orgs:*
orgs:id:*
Restrict an action to a set of organizations. For example, orgs:* matches any organization and orgs:id:1 matches the organization whose ID is 1.
permissions:type:delegateThe scope is only applicable for roles associated with the Access Control itself and indicates that you can delegate your permissions only, or a subset of it, by creating a new role or making an assignment.
permissions:type:escalateThe scope is required to trigger the reset of basic roles permissions. It indicates that users might acquire additional permissions they did not previously have.
plugins:*
plugins:id:*
Restrict an action to a set of plugins. For example, plugins:id:grafana-oncall-app matches Grafana OnCall plugin, and plugins:* matches all plugins.
provisioners:*Restrict an action to a set of provisioners. For example, provisioners:* matches any provisioner, and provisioners:accesscontrol matches the role-based access control provisioner.
reports:*
reports:id:*
Restrict an action to a set of reports. For example, reports:* matches any report and reports:id:1 matches the report whose ID is 1.
roles:*
roles:uid:*
Restrict an action to a set of roles. For example, roles:* matches any role and roles:uid:randomuid matches only the role whose UID is randomuid.
services:accesscontrolRestrict an action to target only the role-based access control service. You can use this in conjunction with the status:accesscontrol actions.
serviceaccounts:*
serviceaccounts:id:*
Restrict an action to a set of service account from an organization. For example, serviceaccounts:* matches any service account and serviceaccount:id:1 matches the service account whose ID is 1.
settings:*Restrict an action to a subset of settings. For example, settings:* matches all settings, settings:auth.saml:* matches all SAML settings, and settings:auth.saml:enabled matches the enable property on the SAML settings.
teams:*
teams:id:*
Restrict an action to a set of teams from an organization. For example, teams:* matches any team and teams:id:1 matches the team whose ID is 1.
users:*
users:id:*
Restrict an action to a set of users from an organization. For example, users:* matches any user and users:id:1 matches the user whose ID is 1.
n/an/a means not applicable. If an action has n/a specified for the scope, then the action does not require a scope. For example, the teams:create action does not require a scope and allows users to create teams.