diff --git a/docs/sources/enterprise/access-control/fine-grained-access-control-references.md b/docs/sources/enterprise/access-control/fine-grained-access-control-references.md index 5a1d99c7f73..36e1e83342b 100644 --- a/docs/sources/enterprise/access-control/fine-grained-access-control-references.md +++ b/docs/sources/enterprise/access-control/fine-grained-access-control-references.md @@ -31,7 +31,7 @@ The reference information that follows complements conceptual information about | `fixed:datasources:writer` | All permissions from `fixed:datasources:reader` and
`datasources:create`
`datasources:write`
`datasources:delete` | Read, query, create, delete, or update a data source. | | `fixed:datasources:id:reader` | `datasources.id:read` | Read the ID of a data source based on its name. | | `fixed:datasources.permissions:reader` | `datasources.permissions:read` | Read data source permissions. | -| `fixed:datasources.permissions:writer` | All permissions from `fixed:datasources.permissions:reader` and
`datasources.permissions:create`
`datasources.permissions:delete`
`datasources.permissions:toggle` | Create, read, or delete permissions of a data source. | +| `fixed:datasources.permissions:writer` | All permissions from `fixed:datasources.permissions:reader` and
`datasources.permissions:write` | Create, read, or delete permissions of a data source. | | `fixed:licensing:reader` | `licensing:read`
`licensing.reports:read` | Read licensing information and licensing reports. | | `fixed:licensing:writer` | All permissions from `fixed:licensing:viewer` and
`licensing:update`
`licensing:delete` | Read licensing information and licensing reports, update and delete the license token. | | `fixed:provisioning:writer` | `provisioning:reload` | Reload provisioning. | diff --git a/docs/sources/enterprise/access-control/permissions.md b/docs/sources/enterprise/access-control/permissions.md index 560fc928360..b5bb0df11ea 100644 --- a/docs/sources/enterprise/access-control/permissions.md +++ b/docs/sources/enterprise/access-control/permissions.md @@ -23,77 +23,75 @@ scope The following list contains fine-grained access control actions. -| Action | Applicable scope | Description | -| -------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `roles:list` | `roles:*` | List available roles without permissions. | -| `roles:read` | `roles:*`
`roles:uid:*` | Read a specific role with its permissions. | -| `roles:write` | `permissions:delegate` | Create or update a custom role. | -| `roles:delete` | `permissions:delegate` | Delete a custom role. | -| `roles.builtin:list` | `roles:*` | List built-in role assignments. | -| `roles.builtin:add` | `permissions:delegate` | Create a built-in role assignment. | -| `roles.builtin:remove` | `permissions:delegate` | Delete a built-in role assignment. | -| `reports.admin:create` | n/a | Create reports. | -| `reports.admin:write` | `reports:*`
`reports:id:*` | Update reports. | -| `reports:delete` | `reports:*`
`reports:id:*` | Delete reports. | -| `reports:read` | `reports:*` | List all available reports or get a specific report. | -| `reports:send` | `reports:*` | Send a report email. | -| `reports.settings:write` | n/a | Update report settings. | -| `reports.settings:read` | n/a | Read report settings. | -| `provisioning:reload` | `provisioners:*` | Reload provisioning files. To find the exact scope for specific provisioner, see [Scope definitions]({{< relref "./permissions.md#scope-definitions" >}}). | -| `users:read` | `global:users:*` | Read or search user profiles. | -| `users:write` | `global:users:*`
`global:users:id` | Update a user’s profile. | -| `users.teams:read` | `global:users:*`
`global:users:id:*` | Read a user’s teams. | -| `users.authtoken:list` | `global:users:*`
`global:users:id:*` | List authentication tokens that are assigned to a user. | -| `users.authtoken:update` | `global:users:*`
`global:users:id:*` | Update authentication tokens that are assigned to a user. | -| `users.password:update` | `global:users:*`
`global:users:id:*` | Update a user’s password. | -| `users:delete` | `global:users:*`
`global:users:id:*` | Delete a user. | -| `users:create` | n/a | Create a user. | -| `users:enable` | `global:users:*`
`global:users:id:*` | Enable a user. | -| `users:disable` | `global:users:*`
`global:users:id:*` | Disable a user. | -| `users.permissions:update` | `global:users:*`
`global:users:id:*` | Update a user’s organization-level permissions. | -| `users:logout` | `global:users:*`
`global:users:id:*` | Sign out a user. | -| `users.quotas:list` | `global:users:*`
`global:users:id:*` | List a user’s quotas. | -| `users.quotas:update` | `global:users:*`
`global:users:id:*` | Update a user’s quotas. | -| `users.roles:list` | `users:*` | List roles assigned directly to a user. | -| `users.roles:add` | `permissions:delegate` | Assign a role to a user. | -| `users.roles:remove` | `permissions:delegate` | Unassign a role from a auser. | -| `users.permissions:list` | `users:*` | List permissions of a user. | -| `org.users:read` | `users:*`
`users:id:*` | Get user profiles within an organization. | -| `org.users:add` | `users:*` | Add a user to an organization. | -| `org.users:remove` | `users:*`
`users:id:*` | Remove a user from an organization. | -| `org.users.role:update` | `users:*`
`users:id:*` | Update the organization role (`Viewer`, `Editor`, or `Admin`) of an organization. | -| `orgs:read` | `orgs:*`
`orgs:id:*` | Read one or more organizations. | -| `orgs:write` | `orgs:*`
`orgs:id:*` | Update one or more organizations. | -| `org:create` | n/a | Create an organization. | -| `orgs:delete` | `orgs:*`
`orgs:id:*` | Delete one or more organizations. | -| `orgs.quotas:read` | `orgs:*`
`orgs:id:*` | Read organization quotas. | -| `orgs.quotas:write` | `orgs:*`
`orgs:id:*` | Update organization quotas. | -| `orgs.preferences:read` | `orgs:*`
`orgs:id:*` | Read organization preferences. | -| `orgs.preferences:write` | `orgs:*`
`orgs:id:*` | Update organization preferences. | -| `ldap.user:read` | n/a | Read users via LDAP. | -| `ldap.user:sync` | n/a | Sync users via LDAP. | -| `ldap.status:read` | n/a | Verify the availability of the LDAP server or servers. | -| `ldap.config:reload` | n/a | Reload the LDAP configuration. | -| `status:accesscontrol` | `services:accesscontrol` | Get access-control enabled status. | -| `settings:read` | `settings:*`
`settings:auth.saml:*`
`settings:auth.saml:enabled` (property level) | Read the [Grafana configuration settings]({{< relref "../../administration/configuration/_index.md" >}}) | -| `settings:write` | `settings:*`
`settings:auth.saml:*`
`settings:auth.saml:enabled` (property level) | Update any Grafana configuration settings that can be [updated at runtime]({{< relref "../../enterprise/settings-updates/_index.md" >}}). | -| `server.stats:read` | n/a | Read Grafana instance statistics. | -| `datasources:explore` | n/a | Enable access to the **Explore** tab. | -| `datasources:read` | n/a
`datasources:*`
`datasources:id:*`
`datasources:uid:*`
`datasources:name:*` | List data sources. | -| `datasources:query` | n/a
`datasources:*`
`datasources:id:*` | Query data sources. | -| `datasources.id:read` | `datasources:*`
`datasources:name:*` | Read data source IDs. | -| `datasources:create` | n/a | Create data sources. | -| `datasources:write` | `datasources:*`
`datasources:id:*` | Update data sources. | -| `datasources:delete` | `datasources:id:*`
`datasources:uid:*`
`datasources:name:*` | Delete data sources. | -| `datasources.permissions:read` | `datasources:*`
`datasources:id:*` | List data source permissions. | -| `datasources.permissions:create` | `datasources:*`
`datasources:id:*` | Create data source permissions. | -| `datasources.permissions:delete` | `datasources:*`
`datasources:id:*` | Delete data source permissions. | -| `datasources.permissions:toggle` | `datasources:*`
`datasources:id:*` | Enable or disable data source permissions. | -| `licensing:read` | n/a | Read licensing information. | -| `licensing:update` | n/a | Update the license token. | -| `licensing:delete` | n/a | Delete the license token. | -| `licensing.reports:read` | n/a | Get custom permission reports. | -| `serviceaccounts:delete` | `serviceaccounts:*`
`serviceaccounts:id:*` | Delete one or more service accounts. | +| Action | Applicable scope | Description | +| ------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `roles:list` | `roles:*` | List available roles without permissions. | +| `roles:read` | `roles:*`
`roles:uid:*` | Read a specific role with its permissions. | +| `roles:write` | `permissions:delegate` | Create or update a custom role. | +| `roles:delete` | `permissions:delegate` | Delete a custom role. | +| `roles.builtin:list` | `roles:*` | List built-in role assignments. | +| `roles.builtin:add` | `permissions:delegate` | Create a built-in role assignment. | +| `roles.builtin:remove` | `permissions:delegate` | Delete a built-in role assignment. | +| `reports.admin:create` | n/a | Create reports. | +| `reports.admin:write` | `reports:*`
`reports:id:*` | Update reports. | +| `reports:delete` | `reports:*`
`reports:id:*` | Delete reports. | +| `reports:read` | `reports:*` | List all available reports or get a specific report. | +| `reports:send` | `reports:*` | Send a report email. | +| `reports.settings:write` | n/a | Update report settings. | +| `reports.settings:read` | n/a | Read report settings. | +| `provisioning:reload` | `provisioners:*` | Reload provisioning files. To find the exact scope for specific provisioner, see [Scope definitions]({{< relref "./permissions.md#scope-definitions" >}}). | +| `users:read` | `global:users:*` | Read or search user profiles. | +| `users:write` | `global:users:*`
`global:users:id` | Update a user’s profile. | +| `users.teams:read` | `global:users:*`
`global:users:id:*` | Read a user’s teams. | +| `users.authtoken:list` | `global:users:*`
`global:users:id:*` | List authentication tokens that are assigned to a user. | +| `users.authtoken:update` | `global:users:*`
`global:users:id:*` | Update authentication tokens that are assigned to a user. | +| `users.password:update` | `global:users:*`
`global:users:id:*` | Update a user’s password. | +| `users:delete` | `global:users:*`
`global:users:id:*` | Delete a user. | +| `users:create` | n/a | Create a user. | +| `users:enable` | `global:users:*`
`global:users:id:*` | Enable a user. | +| `users:disable` | `global:users:*`
`global:users:id:*` | Disable a user. | +| `users.permissions:update` | `global:users:*`
`global:users:id:*` | Update a user’s organization-level permissions. | +| `users:logout` | `global:users:*`
`global:users:id:*` | Sign out a user. | +| `users.quotas:list` | `global:users:*`
`global:users:id:*` | List a user’s quotas. | +| `users.quotas:update` | `global:users:*`
`global:users:id:*` | Update a user’s quotas. | +| `users.roles:list` | `users:*` | List roles assigned directly to a user. | +| `users.roles:add` | `permissions:delegate` | Assign a role to a user. | +| `users.roles:remove` | `permissions:delegate` | Unassign a role from a auser. | +| `users.permissions:list` | `users:*` | List permissions of a user. | +| `org.users:read` | `users:*`
`users:id:*` | Get user profiles within an organization. | +| `org.users:add` | `users:*` | Add a user to an organization. | +| `org.users:remove` | `users:*`
`users:id:*` | Remove a user from an organization. | +| `org.users.role:update` | `users:*`
`users:id:*` | Update the organization role (`Viewer`, `Editor`, or `Admin`) of an organization. | +| `orgs:read` | `orgs:*`
`orgs:id:*` | Read one or more organizations. | +| `orgs:write` | `orgs:*`
`orgs:id:*` | Update one or more organizations. | +| `org:create` | n/a | Create an organization. | +| `orgs:delete` | `orgs:*`
`orgs:id:*` | Delete one or more organizations. | +| `orgs.quotas:read` | `orgs:*`
`orgs:id:*` | Read organization quotas. | +| `orgs.quotas:write` | `orgs:*`
`orgs:id:*` | Update organization quotas. | +| `orgs.preferences:read` | `orgs:*`
`orgs:id:*` | Read organization preferences. | +| `orgs.preferences:write` | `orgs:*`
`orgs:id:*` | Update organization preferences. | +| `ldap.user:read` | n/a | Read users via LDAP. | +| `ldap.user:sync` | n/a | Sync users via LDAP. | +| `ldap.status:read` | n/a | Verify the availability of the LDAP server or servers. | +| `ldap.config:reload` | n/a | Reload the LDAP configuration. | +| `status:accesscontrol` | `services:accesscontrol` | Get access-control enabled status. | +| `settings:read` | `settings:*`
`settings:auth.saml:*`
`settings:auth.saml:enabled` (property level) | Read the [Grafana configuration settings]({{< relref "../../administration/configuration/_index.md" >}}) | +| `settings:write` | `settings:*`
`settings:auth.saml:*`
`settings:auth.saml:enabled` (property level) | Update any Grafana configuration settings that can be [updated at runtime]({{< relref "../../enterprise/settings-updates/_index.md" >}}). | +| `server.stats:read` | n/a | Read Grafana instance statistics. | +| `datasources:explore` | n/a | Enable access to the **Explore** tab. | +| `datasources:read` | n/a
`datasources:*`
`datasources:id:*`
`datasources:uid:*`
`datasources:name:*` | List data sources. | +| `datasources:query` | n/a
`datasources:*`
`datasources:id:*` | Query data sources. | +| `datasources.id:read` | `datasources:*`
`datasources:name:*` | Read data source IDs. | +| `datasources:create` | n/a | Create data sources. | +| `datasources:write` | `datasources:*`
`datasources:id:*` | Update data sources. | +| `datasources:delete` | `datasources:id:*`
`datasources:uid:*`
`datasources:name:*` | Delete data sources. | +| `datasources.permissions:read` | `datasources:*`
`datasources:id:*` | List data source permissions. | +| `datasources.permissions:write` | `datasources:*`
`datasources:id:*` | Update data source permissions. | +| `licensing:read` | n/a | Read licensing information. | +| `licensing:update` | n/a | Update the license token. | +| `licensing:delete` | n/a | Delete the license token. | +| `licensing.reports:read` | n/a | Get custom permission reports. | +| `serviceaccounts:delete` | `serviceaccounts:*`
`serviceaccounts:id:*` | Delete one or more service accounts. | ## Scope definitions diff --git a/docs/sources/http_api/datasource_permissions.md b/docs/sources/http_api/datasource_permissions.md index dc7e2d970f9..bc8acd8dd4a 100644 --- a/docs/sources/http_api/datasource_permissions.md +++ b/docs/sources/http_api/datasource_permissions.md @@ -30,9 +30,9 @@ Enables permissions for the data source with the given `id`. No one except Org A See note in the [introduction]({{< ref "#data-source-permissions-api" >}}) for an explanation. -| Action | Scope | -| ------------------------------ | ---------------------------------------------------------------------------- | -| datasources.permissions:toggle | datasources:\*
datasources:id:\*
datasources:id:1 (single data source) | +| Action | Scope | +| ----------------------------- | ---------------------------------------------------------------------------- | +| datasources.permissions:write | datasources:\*
datasources:id:\*
datasources:id:1 (single data source) | ### Examples @@ -75,9 +75,9 @@ Disables permissions for the data source with the given `id`. All existing permi See note in the [introduction]({{< ref "#data-source-permissions-api" >}}) for an explanation. -| Action | Scope | -| ------------------------------ | ---------------------------------------------------------------------------- | -| datasources.permissions:toggle | datasources:\*
datasources:id:\*
datasources:id:1 (single data source) | +| Action | Scope | +| ----------------------------- | ---------------------------------------------------------------------------- | +| datasources.permissions:write | datasources:\*
datasources:id:\*
datasources:id:1 (single data source) | ### Examples @@ -191,9 +191,9 @@ Adds a user permission for the data source with the given `id`. See note in the [introduction]({{< ref "#data-source-permissions-api" >}}) for an explanation. -| Action | Scope | -| ------------------------------ | ---------------------------------------------------------------------------- | -| datasources.permissions:create | datasources:\*
datasources:id:\*
datasources:id:1 (single data source) | +| Action | Scope | +| ----------------------------- | ---------------------------------------------------------------------------- | +| datasources.permissions:write | datasources:\*
datasources:id:\*
datasources:id:1 (single data source) | ### Examples @@ -265,9 +265,9 @@ Removes the permission with the given `permissionId` for the data source with th See note in the [introduction]({{< ref "#data-source-permissions-api" >}}) for an explanation. -| Action | Scope | -| ------------------------------ | ---------------------------------------------------------------------------- | -| datasources.permissions:delete | datasources:\*
datasources:id:\*
datasources:id:1 (single data source) | +| Action | Scope | +| ----------------------------- | ---------------------------------------------------------------------------- | +| datasources.permissions:write | datasources:\*
datasources:id:\*
datasources:id:1 (single data source) | ### Examples