public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[v11.3] Remove relref shortcodes (#101715) (#101993)

Browse Source 
* manually replce all shared relrefs

* relref replace - previous grafana versions

* update test

* prettier

(cherry picked from commit 3f07134896)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Co-authored-by: Robby Milo <robbymilo@fastmail.com>
This commit is contained in:
Jack Baldry
2025-03-12 11:18:16 +00:00
committed by GitHub
parent 0e1acbaf3e
commit bb19e14a97
176 changed files with 1419 additions and 1422 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/http_api/access_control.md
+25 -25
View File
@@ -21,7 +21,7 @@ title: RBAC HTTP API
# RBAC API
> Role-based access control API is only available in Grafana Cloud or Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "/docs/grafana/latest/introduction/grafana-enterprise" >}}).
> Role-based access control API is only available in Grafana Cloud or Grafana Enterprise. Read more about [Grafana Enterprise](/docs/grafana/latest/introduction/grafana-enterprise/).
The API can be used to create, update, delete, get, and list roles.
@@ -226,7 +226,7 @@ Content-Type: application/json; charset=UTF-8
Content-Type: application/json
{
```
```http
HTTP/1.1 400 Bad Request
Content-Type: application/json
@@ -264,24 +264,24 @@ Content-Type: application/json
Update the role with the given UID, and its permissions. The operation is idempotent and all permissions of the role will be replaced based on the request content. You need to increment the version of the role with each update, otherwise the request will fail.
You can update `custom` roles and `basic` roles permissions. However `fixed` roles cannot be updated.
#### Required permissions
`permissions:type:delegate` scope ensures that users can only update custom roles with the same, or a subset of permissions which the user has.
For example, if a user does not have required permissions for creating users, they won't be able to update a custom role which allows to do that. This is done to prevent escalation of privileges.
| Action | Scope |
| ----------- | ------------------------- |
| roles:write | permissions:type:delegate |
You can update `custom` roles and `basic` roles permissions. However `fixed` roles cannot be updated.
#### Required permissions
`permissions:type:delegate` scope ensures that users can only update custom roles with the same, or a subset of permissions which the user has.
For example, if a user does not have required permissions for creating users, they won't be able to update a custom role which allows to do that. This is done to prevent escalation of privileges.
| Action | Scope |
| ----------- | ------------------------- |
| roles:write | permissions:type:delegate |
#### Example request
```http
PUT /api/access-control/roles/jZrmlLCGka
Accept: application/json
Content-Type: application/json
PUT /api/access-control/roles/jZrmlLCGka
Accept: application/json
Content-Type: application/json
{
"version": 3,
"name": "custom:delete:write:roles",
@@ -449,10 +449,10 @@ Content-Type: application/json
#### Query parameters
| Param | Type | Required | Description |
| ----------- | ------- | -------- | -------------------------------------- |
| reloadcache | boolean | No | A flag to reload the permission cache. |
#### Example request
| ----------- | ------- | -------- | -------------------------------------- |
| reloadcache | boolean | No | A flag to reload the permission cache. |
#### Example request
```http
GET /api/access-control/user/permissions
@@ -530,10 +530,10 @@ Accept: application/json
#### Example request
```http
POST /api/access-control/users/1/roles
Accept: application/json
Content-Type: application/json
```http
POST /api/access-control/users/1/roles
Accept: application/json
Content-Type: application/json
{
"global": false,