IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2026-07-30 00:08:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

AccessControl: Document role display name (#40068)

Browse Source 
* docs: role displayname

* Update docs/sources/enterprise/access-control/roles.md

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>

* Update docs/sources/enterprise/access-control/roles.md

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>

* refactor: update accesscontrol based on fixed roles

* update displayname text

* Update docs/sources/enterprise/access-control/roles.md

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>

* updated group

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
Co-authored-by: eleijonmarck <eleijonmarck@Erics-MBP.home>
This commit is contained in:
Eric Leijonmarck
2021-11-29 15:06:10 +01:00
committed by GitHub
co-authored by Ursula Kallio eleijonmarck
parent e1a3b6a386
commit d997e051c2
3 changed files with 47 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/enterprise/access-control/roles.md
+6 -2
View File
@@ -44,13 +44,17 @@ Role names must be unique within an organization.
Roles with names prefixed by `fixed:` are fixed roles created by Grafana and cannot be created or modified by users. Roles with names prefixed by `fixed:` are fixed roles created by Grafana and cannot be created or modified by users.
### Role display name
A role’s display name is human friendly text that is displayed in the UI. When you create a display name for a role, use up to 190 ASCII-based characters. For fixed roles, the display name is shown as specified. If the display name has not been set the display name replace any `:` (a colon) with ` ` (a space).
### Display name ### Display name
A role's display name is intended as a human friendly identifier for the role, helping users understand the purpose of a role. The display name of the role is displayed in the role picker in the UI. A role’s display name is a human-friendly identifier for the role, so that users more easily understand the purpose of a role. You can see the display name in the role picker in the UI.
### Group ### Group
A role's group is used to organize roles in the role picker in the UI. A role’s group organizes roles in the role picker in the UI.
### Role version ### Role version
docs/sources/enterprise/access-control/usage-scenarios.md
+17 -19
View File
@@ -33,8 +33,9 @@ Example response:
{ {
"version": 2, "version": 2,
"uid": "qQui_LCMk", "uid": "qQui_LCMk",
"name": "fixed:users:org:edit", "name": "fixed:users:org:writer",
"description": "Allows every read action for user organizations and in addition allows to administer user organizations.", "displayName": "Users Organization writer",
"description": "Within a single organization, add a user, invite a user, read information about a user and their role, remove a user from that organization, or change the role of a user.",
"global": true, "global": true,
"updated": "2021-05-17T20:49:18+02:00", "updated": "2021-05-17T20:49:18+02:00",
"created": "2021-05-13T16:24:26+02:00" "created": "2021-05-13T16:24:26+02:00"
@@ -42,8 +43,9 @@ Example response:
{ {
"version": 1, "version": 1,
"uid": "Kz9m_YjGz", "uid": "Kz9m_YjGz",
"name": "fixed:reporting:admin:edit", "name": "fixed:reports:writer",
"description": "Gives access to edit any report or the organization's general reporting settings.", "displayName": "Report writer",
"description": "Create, read, update, or delete all reports and shared report settings.",
"global": true, "global": true,
"updated": "2021-05-13T16:24:26+02:00", "updated": "2021-05-13T16:24:26+02:00",
"created": "2021-05-13T16:24:26+02:00" "created": "2021-05-13T16:24:26+02:00"
@@ -55,8 +57,9 @@ Example response:
{ {
"version": 2, "version": 2,
"uid": "qQui_LCMk", "uid": "qQui_LCMk",
"name": "fixed:users:org:edit", "name": "fixed:users:writer",
"description": "Allows every read action for user organizations and in addition allows to administer user organizations.", "displayName": "User writer",
"description": "Read and update all attributes and settings for all users in Grafana: update user information, read user information, create or enable or disable a user, make a user a Grafana administrator, sign out a user, update a user’s authentication token, or update quotas for all users.",
"global": true, "global": true,
"updated": "2021-05-17T20:49:18+02:00", "updated": "2021-05-17T20:49:18+02:00",
"created": "2021-05-13T16:24:26+02:00" "created": "2021-05-13T16:24:26+02:00"
@@ -64,17 +67,9 @@ Example response:
{ {
"version": 2, "version": 2,
"uid": "ajum_YjGk", "uid": "ajum_YjGk",
"name": "fixed:users:admin:read", "name": "fixed:users:reader",
"description": "Allows to list and get users and related information.", "displayName": "User reader",
"global": true, "description": "Allows every read action for user organizations and in addition allows to administer user organizations.",
"updated": "2021-05-17T20:49:17+02:00",
"created": "2021-05-13T16:24:26+02:00"
},
{
"version": 2,
"uid": "K3um_LCMk",
"name": "fixed:users:admin:edit",
"description": "Allows every read action for users and in addition allows to administer users.",
"global": true, "global": true,
"updated": "2021-05-17T20:49:17+02:00", "updated": "2021-05-17T20:49:17+02:00",
"created": "2021-05-13T16:24:26+02:00" "created": "2021-05-13T16:24:26+02:00"
@@ -98,8 +93,9 @@ Example response:
{ {
"version": 2, "version": 2,
"uid": "qQui_LCMk", "uid": "qQui_LCMk",
"name": "fixed:users:org:edit", "name": "fixed:users:writer",
"description": "Allows every read action for user organizations and in addition allows to administer user organizations.", "displayName": "User writer",
"description": "Read and update all attributes and settings for all users in Grafana: update user information, read user information, create or enable or disable a user, make a user a Grafana administrator, sign out a user, update a user’s authentication token, or update quotas for all users.",
"global": true, "global": true,
"permissions": [ "permissions": [
{ {
@@ -151,6 +147,7 @@ curl --location --request POST '<grafana_url>/api/access-control/roles/' \
"version": 1, "version": 1,
"uid": "jZrmlLCkGksdka", "uid": "jZrmlLCkGksdka",
"name": "custom:users:admin", "name": "custom:users:admin",
"displayName": "custom users admin",
"description": "My custom role which gives users permissions to create users", "description": "My custom role which gives users permissions to create users",
"global": true, "global": true,
"permissions": [ "permissions": [
@@ -168,6 +165,7 @@ Example response:
"version": 1, "version": 1,
"uid": "jZrmlLCkGksdka", "uid": "jZrmlLCkGksdka",
"name": "custom:users:admin", "name": "custom:users:admin",
"displayName": "custom users admin",
"description": "My custom role which gives users permissions to create users", "description": "My custom role which gives users permissions to create users",
"global": true, "global": true,
"permissions": [ "permissions": [
docs/sources/http_api/access_control.md
+24 -19
View File
@@ -97,16 +97,14 @@ Content-Type: application/json; charset=UTF-8
"global": false "global": false
}, },
{ {
"version": 4, "version": 5,
"uid": "6dNwJq57z", "uid": "vi9mlLjGz",
"name": "fixed:reports:writer", "name": "fixed:datasources.permissions:writer",
"displayName": "Report writer", "description: "Create, read or delete data source permissions.",
"description": "Create, read, update, or delete all reports and shared report settings.", "global": true,
"group": "Reports", "updated": "2021-05-13T22:41:49+02:00",
"updated": "2021-11-19T10:48:00+01:00", "created": "2021-05-13T16:24:26+02:00"
"created": "2021-11-19T10:48:00+01:00", }
"global": false
},
] ]
``` ```
@@ -235,6 +233,7 @@ Content-Type: application/json
"version": 1, "version": 1,
"uid": "jZrmlLCGka", "uid": "jZrmlLCGka",
"name": "custom:delete:roles", "name": "custom:delete:roles",
"displayName": "custom delete roles",
"description": "My custom role which gives users permissions to delete roles", "description": "My custom role which gives users permissions to delete roles",
"group":"My Group", "group":"My Group",
"displayName": "My Custom Role", "displayName": "My Custom Role",
@@ -278,6 +277,7 @@ Content-Type: application/json; charset=UTF-8
"version": 2, "version": 2,
"uid": "jZrmlLCGka", "uid": "jZrmlLCGka",
"name": "custom:delete:create:roles", "name": "custom:delete:create:roles",
"displayName": "custom delete create roles",
"description": "My custom role which gives users permissions to delete and create roles", "description": "My custom role which gives users permissions to delete and create roles",
"group":"My Group", "group":"My Group",
"displayName": "My Custom Role", "displayName": "My Custom Role",
@@ -329,6 +329,7 @@ Content-Type: application/json
{ {
"version": 3, "version": 3,
"name": "custom:delete:write:roles", "name": "custom:delete:write:roles",
"displayName": "custom delete write roles",
"description": "My custom role which gives users permissions to delete and write roles", "description": "My custom role which gives users permissions to delete and write roles",
"group":"My Group", "group":"My Group",
"displayName": "My Custom Role", "displayName": "My Custom Role",
@@ -374,6 +375,7 @@ Content-Type: application/json; charset=UTF-8
"version":3, "version":3,
"uid":"jZrmlLCGka", "uid":"jZrmlLCGka",
"name":"custom:delete:write:roles", "name":"custom:delete:write:roles",
"displayName":"custom delete write roles",
"description":"My custom role which gives users permissions to delete and write roles", "description":"My custom role which gives users permissions to delete and write roles",
"group":"My Group", "group":"My Group",
"displayName": "My Custom Role", "displayName": "My Custom Role",
@@ -759,18 +761,20 @@ Content-Type: application/json; charset=UTF-8
{ {
"version": 1, "version": 1,
"uid": "qQui_LCMk", "uid": "qQui_LCMk",
"name": "fixed:users:org:edit", "name": "fixed:users:writer",
"description": "", "name": "User writer",
"global": false, "description": "Read and update all attributes and settings for all users in Grafana: update user information, read user information, create or enable or disable a user, make a user a Grafana administrator, sign out a user, update a user’s authentication token, or update quotas for all users",
"global": true,
"updated": "2021-05-13T16:24:26+02:00", "updated": "2021-05-13T16:24:26+02:00",
"created": "2021-05-13T16:24:26+02:00" "created": "2021-05-13T16:24:26+02:00"
}, },
{ {
"version": 1, "version": 1,
"uid": "PeXmlYjMk", "uid": "PeXmlYjMk",
"name": "fixed:users:org:read", "name": "fixed:users:reader",
"description": "", "displayName": "User reader",
"global": false, "description": "Allows every read action for user organizations and in addition allows to administer user organizations",
"global": true,
"updated": "2021-05-13T16:24:26+02:00", "updated": "2021-05-13T16:24:26+02:00",
"created": "2021-05-13T16:24:26+02:00" "created": "2021-05-13T16:24:26+02:00"
} }
@@ -779,9 +783,10 @@ Content-Type: application/json; charset=UTF-8
{ {
"version": 1, "version": 1,
"uid": "qQui_LCMk", "uid": "qQui_LCMk",
"name": "fixed:users:org:edit", "name": "fixed:users:writer",
"description": "", "displayName": "User writer",
"global": false, "description": "Read and update all attributes and settings for all users in Grafana: update user information, read user information, create or enable or disable a user, make a user a Grafana administrator, sign out a user, update a user’s authentication token, or update quotas for all users",
"global": true,
"updated": "2021-05-13T16:24:26+02:00", "updated": "2021-05-13T16:24:26+02:00",
"created": "2021-05-13T16:24:26+02:00" "created": "2021-05-13T16:24:26+02:00"
} }