diff --git a/docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md b/docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md index 82b5269f979..b6bf833aa0f 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md @@ -65,11 +65,10 @@ The following list contains role-based access control actions. | `alert.provisioning.secrets:read` | None | Same as `alert.provisioning:read` plus ability to export resources with decrypted secrets. | | `alert.provisioning:write` | None | Update all Grafana alert rules, notification policies, etc via provisioning API. Permissions to folders and datasource are not required. | | `alert.provisioning.provenance:write` | None | Set provisioning status for alerting resources. Cannot be used alone. Requires user to have permissions to access resources | -| `annotations:create` | | Create annotations. | -| `annotations:delete` | | Delete annotations. | -| `annotations:read` | | Read annotations and annotation tags. | -| `annotations:write` | | Update annotations. | -| `apikeys:create` | None | Create API keys. | +| `annotations:create` | | Create annotations. | +| `annotations:delete` | | Delete annotations. | +| `annotations:read` | | Read annotations and annotation tags. | +| `annotations:write` | | Update annotations. | | `apikeys:read` | | Read API keys. | | `apikeys:delete` | | Delete API keys. | | `dashboards:create` | | Create dashboards in one or more folders and their subfolders. | diff --git a/docs/sources/developers/http_api/annotations.md b/docs/sources/developers/http_api/annotations.md index 4d58b32a829..365c717062e 100644 --- a/docs/sources/developers/http_api/annotations.md +++ b/docs/sources/developers/http_api/annotations.md @@ -32,9 +32,12 @@ Annotations are saved in the Grafana database (sqlite, mysql or postgres). Annot See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation. -| Action | Scope | -| ---------------- | ----------------------- | -| annotations:read | annotations:type: | + +| Action | Scope | +| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `annotations:read` | | +{ .no-spacing-list } + **Example Request**: @@ -122,9 +125,12 @@ The format for `time` and `timeEnd` should be epoch numbers in millisecond resol See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation. -| Action | Scope | -| ------------------ | ----------------------- | -| annotations:create | annotations:type: | + +| Action | Scope | +| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `annotations:create` | | +{ .no-spacing-list } + **Required JSON Body Fields** @@ -174,9 +180,9 @@ format (string with multiple tags being separated by a space). See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation. -| Action | Scope | -| ------------------ | ----------------------------- | -| annotations:create | annotations:type:organization | +| Action | Scope | +| -------------------- | ------------------------------- | +| `annotations:create` | `annotations:type:organization` | **Example Request**: @@ -215,9 +221,12 @@ Updates all properties of an annotation that matches the specified id. To only u See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation. -| Action | Scope | -| ----------------- | ----------------------- | -| annotations:write | annotations:type: | + +| Action | Scope | +| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `annotations:write` |
  • `annotations:*`
  • `annotations:type:*`
  • `dashboards:*`
  • `dashboards:uid:*`
  • `folders:*`
  • `folders:uid:*`
| +{ .no-spacing-list } + **Example Request**: @@ -260,9 +269,12 @@ This operation currently supports updating of the `text`, `tags`, `time` and `ti See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation. -| Action | Scope | -| ----------------- | ----------------------- | -| annotations:write | annotations:type: | + +| Action | Scope | +| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `annotations:write` |
  • `annotations:*`
  • `annotations:type:*`
  • `dashboards:*`
  • `dashboards:uid:*`
  • `folders:*`
  • `folders:uid:*`
| +{ .no-spacing-list } + **Example Request**: @@ -299,9 +311,12 @@ Deletes the annotation that matches the specified id. See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation. -| Action | Scope | -| ------------------ | ----------------------- | -| annotations:delete | annotations:type: | + +| Action | Scope | +| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `annotations:delete` |
  • `annotations:*`
  • `annotations:type:*`
  • `dashboards:*`
  • `dashboards:uid:*`
  • `folders:*`
  • `folders:uid:*`
| +{ .no-spacing-list } + **Example Request**: @@ -333,9 +348,9 @@ Find all the event tags created in the annotations. See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation. -| Action | Scope | -| ---------------- | ----- | -| annotations:read | N/A | +| Action | Scope | +| ------------------ | ----- | +| `annotations:read` | N/A | **Example Request**: diff --git a/docs/sources/developers/http_api/dashboard.md b/docs/sources/developers/http_api/dashboard.md index e51af8a6575..27d33d661e8 100644 --- a/docs/sources/developers/http_api/dashboard.md +++ b/docs/sources/developers/http_api/dashboard.md @@ -43,9 +43,13 @@ Creates a new dashboard or updates an existing dashboard. When updating existing See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation. -| Action | Scope | -| ------------------- | ----------- | -| `dashboards:create` | `folders:*` | + +| Action | Scope | +| ------------------- | ------------------------------------------------------------------------------------------------------- | +| `dashboards:create` |
  • `folders:*`
  • `folders:uid:*`
| +| `dashboards:write` |
  • `dashboards:*`
  • `dashboards:uid:*`
  • `folders:*`
  • `folders:uid:*`
| +{ .no-spacing-list } + **Example Request for new dashboard**: @@ -164,9 +168,12 @@ Will return the dashboard given the dashboard unique identifier (uid). Informati See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation. -| Action | Scope | -| ----------------- | -------------- | -| `dashboards:read` | `dashboards:*` | + +| Action | Scope | +| ----------------- | ------------------------------------------------------------------------------------------------------- | +| `dashboards:read` |
  • `dashboards:*`
  • `dashboards:uid:*`
  • `folders:*`
  • `folders:uid:*`
| +{ .no-spacing-list } + **Example Request**: @@ -220,9 +227,12 @@ Will delete the dashboard given the specified unique identifier (uid). See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation. -| Action | Scope | -| ------------------- | ----------------------------- | -| `dashboards:delete` | `dashboards:*`
`folders:*` | + +| Action | Scope | +| ------------------- | ------------------------------------------------------------------------------------------------------- | +| `dashboards:delete` |
  • `dashboards:*`
  • `dashboards:uid:*`
  • `folders:*`
  • `folders:uid:*`
| +{ .no-spacing-list } + **Example Request**: @@ -267,9 +277,12 @@ Will delete permanently the dashboard given the specified unique identifier (uid See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation. -| Action | Scope | -| ------------------- | ----------------------------- | -| `dashboards:delete` | `dashboards:*`
`folders:*` | + +| Action | Scope | +| ------------------- | ------------------------------------------------------------------------------------------------------- | +| `dashboards:delete` |
  • `dashboards:*`
  • `dashboards:uid:*`
  • `folders:*`
  • `folders:uid:*`
| +{ .no-spacing-list } + **Example Request**: @@ -314,9 +327,12 @@ Will restore a deleted dashboard given the specified unique identifier (uid). See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation. -| Action | Scope | -| ------------------- | ----------------------------- | -| `dashboards:create` | `dashboards:*`
`folders:*` | + +| Action | Scope | +| ------------------- | ----------------------------------------------------- | +| `dashboards:create` |
  • `folders:*`
  • `folders:uid:*`
| +{ .no-spacing-list } + **Example Request**: diff --git a/docs/sources/developers/http_api/dashboard_permissions.md b/docs/sources/developers/http_api/dashboard_permissions.md index d9544943e1c..5f2844be2cb 100644 --- a/docs/sources/developers/http_api/dashboard_permissions.md +++ b/docs/sources/developers/http_api/dashboard_permissions.md @@ -44,9 +44,12 @@ Gets all existing permissions for the dashboard with the given `uid`. See note in the [introduction]({{< ref "#dashboard-permission-api" >}}) for an explanation. -| Action | Scope | -| ----------------------------- | ------------------------------------- | -| `dashboards.permissions:read` | `dashboards:uid:*`
`folders:uid:*` | + +| Action | Scope | +| ----------------------------- | ------------------------------------------------------------------------------------------------------- | +| `dashboards.permissions:read` |
  • `dashboards:*`
  • `dashboards:uid:*`
  • `folders:*`
  • `folders:uid:*`
| +{ .no-spacing-list } + **Example request**: @@ -123,9 +126,12 @@ Updates permissions for a dashboard. This operation will remove existing permiss See note in the [introduction]({{< ref "#dashboard-permission-api" >}}) for an explanation. -| Action | Scope | -| ------------------------------ | ------------------------------------- | -| `dashboards.permissions:write` | `dashboards:uid:*`
`folders:uid:*` | + +| Action | Scope | +| ------------------------------ | ------------------------------------------------------------------------------------------------------- | +| `dashboards.permissions:write` |
  • `dashboards:*`
  • `dashboards:uid:*`
  • `folders:*`
  • `folders:uid:*`
| +{ .no-spacing-list } + **Example request**: @@ -192,9 +198,12 @@ Gets all existing permissions for the dashboard with the given `dashboardId`. See note in the [introduction]({{< ref "#dashboard-permission-api" >}}) for an explanation. -| Action | Scope | -| ----------------------------- | ----------------------------- | -| `dashboards.permissions:read` | `dashboards:*`
`folders:*` | + +| Action | Scope | +| ----------------------------- | ------------------------------------------------------------------------------------------------------- | +| `dashboards.permissions:read` |
  • `dashboards:*`
  • `dashboards:uid:*`
  • `folders:*`
  • `folders:uid:*`
| +{ .no-spacing-list } + **Example request**: @@ -275,9 +284,12 @@ Updates permissions for a dashboard. This operation will remove existing permiss See note in the [introduction]({{< ref "#dashboard-permission-api" >}}) for an explanation. -| Action | Scope | -| ------------------------------ | ----------------------------- | -| `dashboards.permissions:write` | `dashboards:*`
`folders:*` | + +| Action | Scope | +| ------------------------------ | ------------------------------------------------------------------------------------------------------- | +| `dashboards.permissions:write` |
  • `dashboards:*`
  • `dashboards:uid:*`
  • `folders:*`
  • `folders:uid:*`
| +{ .no-spacing-list } + **Example request**: