Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
Fine-grained access control API
Fine-grained access control API is only available in Grafana Enterprise. Read more about Grafana Enterprise.
The API can be used to create, update, get and list roles, and create or remove built-in role assignments. To use the API, you would need to enable fine-grained access control.
The API does not currently work with an API Token. So in order to use these API endpoints you will have to use Basic auth.
Get status
GET /api/access-control/status
Returns an indicator to check if fine-grained access control is enabled or not.
Required permissions
Action | Scope |
---|---|
status:accesscontrol | services:accesscontrol |
Example request
GET /api/access-control/check
Accept: application/json
Content-Type: application/json
Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"enabled": true
}
Status codes
Code | Description |
---|---|
200 | Returned a flag indicating if the fine-grained access control is enabled or no. |
403 | Access denied |
404 | Not found, an indication that fine-grained access control is not available at all. |
500 | Unexpected error. Refer to body and/or server logs for more details. |
Create and manage custom roles
Get all roles
GET /api/access-control/roles
Gets all existing roles. The response contains all global and organization local roles, for the organization which user is signed in. Refer to the Role scopes for more information.
Required permissions
Action | Scope |
---|---|
roles:list | roles:* |
Example request
GET /api/access-control/roles
Accept: application/json
Content-Type: application/json
Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
[
{
"version": 1,
"uid": "Kz9m_YjGz",
"name": "fixed:reporting:admin:edit",
"description": "Gives access to edit any report or the organization's general reporting settings.",
"global": true,
"updated": "2021-05-13T16:24:26+02:00",
"created": "2021-05-13T16:24:26+02:00"
},
{
"version": 5,
"uid": "vi9mlLjGz",
"name": "fixed:permissions:admin:read",
"description": "Gives access to read and list roles and permissions, as well as built-in role assignments.",
"global": true,
"updated": "2021-05-13T22:41:49+02:00",
"created": "2021-05-13T16:24:26+02:00"
}
]
Status codes
Code | Description |
---|---|
200 | Global and organization local roles are returned. |
403 | Access denied |
500 | Unexpected error. Refer to body and/or server logs for more details. |
Get a role
GET /api/access-control/roles/:uid
Get a role for the given UID.
Required permissions
Action | Scope |
---|---|
roles:read | roles:* |
Example request
GET /api/access-control/roles/PYnDO3rMk
Accept: application/json
Content-Type: application/json
Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"version": 2,
"uid": "jZrmlLCGk",
"name": "fixed:permissions:admin:edit",
"description": "Gives access to create, update and delete roles, as well as manage built-in role assignments.",
"global": true,
"permissions": [
{
"action": "roles:delete",
"scope": "permissions:delegate",
"updated": "2021-05-13T16:24:26+02:00",
"created": "2021-05-13T16:24:26+02:00"
},
{
"action": "roles:list",
"scope": "roles:*",
"updated": "2021-05-13T16:24:26+02:00",
"created": "2021-05-13T16:24:26+02:00"
}
],
"updated": "2021-05-13T16:24:26+02:00",
"created": "2021-05-13T16:24:26+02:00"
}
Status codes
Code | Description |
---|---|
200 | Role is returned. |
403 | Access denied |
500 | Unexpected error. Refer to body and/or server logs for more details. |
Create a new custom role
POST /api/access-control/roles
Creates a new custom role and maps given permissions to that role. Note that roles with the same prefix as Fixed Roles can’t be created.
Required permissions
permission:delegate
scope ensures that users can only create 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 create a custom role which allows to do that. This is done to prevent escalation of privileges.
Action | Scope |
---|---|
roles:write | permissions:delegate |
Example request
POST /api/access-control/roles
Accept: application/json
Content-Type: application/json
{
"version": 1,
"uid": "jZrmlLCGka",
"name": "custom:delete:roles",
"description": "My custom role which gives users permissions to delete roles",
"global": true,
"permissions": [
{
"action": "roles:delete",
"scope": "permissions:delegate"
}
]
}
JSON body schema
Field Name | Date Type | Required | Description |
---|---|---|---|
uid | string | No | UID of the role. If not present, the UID will be automatically created for you and returned in response. Refer to the Custom roles for more information. |
global | boolean | No | A flag indicating if the role is global or not. If set to false , the default org ID of the authenticated user will be used from the request. Refer to the Role scopes for more information. |
version | number | No | Version of the role. If not present, version 0 will be assigned to the role and returned in the response. Refer to the Custom roles for more information. |
name | string | Yes | Name of the role. Refer to Custom roles for more information. |
description | string | No | Description of the role. |
permissions | Permission | No | If not present, the role will be created without any permissions. |
Permission
Field Name | Data Type | Required | Description |
---|---|---|---|
action | string | Yes | Refer to Permissions for full list of available actions. |
scope | string | No | If not present, no scope will be mapped to the permission. Refer to Permissions for full list of available scopes. |
Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"version": 2,
"uid": "jZrmlLCGka",
"name": "custom:delete:create:roles",
"description": "My custom role which gives users permissions to delete and create roles",
"global": true,
"permissions": [
{
"action": "roles:delete",
"scope": "permissions:delegate",
"updated": "2021-05-13T23:19:46+02:00",
"created": "2021-05-13T23:19:46+02:00"
}
],
"updated": "2021-05-13T23:20:51.416518+02:00",
"created": "2021-05-13T23:19:46+02:00"
}
Status codes
Code | Description |
---|---|
200 | Role is updated. |
400 | Bad request (invalid json, missing content-type, missing or invalid fields, etc.). |
403 | Access denied |
500 | Unexpected error. Refer to body and/or server logs for more details. |
Update a custom role
PUT /api/access-control/roles/:uid
Update the role with the given UID, and it’s permissions with the given UID. The operation is idempotent and all permissions of the role will be replaced with what is in the request. You would need to increment the version of the role with each update, otherwise the request will fail.
Required permissions
permission: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:delegate |
Example request
PUT /api/access-control/roles/jZrmlLCGka
Accept: application/json
Content-Type: application/json
{
"version": 2,
"name": "custom:delete:create:roles",
"description": "My custom role which gives users permissions to delete and create roles",
"permissions": [
{
"action": "roles:delete",
"scope": "permissions:delegate"
},
{
"action": "roles:create",
"scope": "permissions:delegate"
}
]
}
JSON body schema
Field Name | Data Type | Required | Description |
---|---|---|---|
version | number | Yes | Version of the role. Must be incremented for update to work. |
name | string | Yes | Name of the role. |
description | string | No | Description of the role. |
permissions | List of Permissions | No | The full list of permissions the role should have after the update. |
Permission
Field Name | Data Type | Required | Description |
---|---|---|---|
action | string | Yes | Refer to Permissions for full list of available actions. |
scope | string | No | If not present, no scope will be mapped to the permission. Refer to Permissions for full list of available scopes. |
Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"version": 3,
"name": "custom:delete:create:roles",
"description": "My custom role which gives users permissions to delete and create roles",
"permissions": [
{
"action": "roles:delete",
"scope": "permissions:delegate",
"updated": "2021-05-13T23:19:46.546146+02:00",
"created": "2021-05-13T23:19:46.546146+02:00"
},
{
"action": "roles:create",
"scope": "permissions:delegate",
"updated": "2021-05-13T23:19:46.546146+02:00",
"created": "2021-05-13T23:19:46.546146+02:00"
}
],
"updated": "2021-05-13T23:19:46.540987+02:00",
"created": "2021-05-13T23:19:46.540986+02:00"
}
Status codes
Code | Description |
---|---|
200 | Role is updated. |
400 | Bad request (invalid json, missing content-type, missing or invalid fields, etc.). |
403 | Access denied |
404 | Role was not found to update. |
500 | Unexpected error. Refer to body and/or server logs for more details. |
Delete a custom role
DELETE /api/access-control/roles/:uid?force=false
Delete a role with the given UID, and it’s permissions. If the role is assigned to a built-in role, the deletion operation will fail, unless force
query param is set to true
, and in that case all assignments will also be deleted.
Required permissions
permission:delegate
scope ensures that users can only delete a custom role 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 delete a custom role which allows to do that.
Action | Scope |
---|---|
roles:delete | permissions:delegate |
Example request
DELETE /api/access-control/roles/jZrmlLCGka?force=true
Accept: application/json
Query parameters
Param | Type | Required | Description |
---|---|---|---|
force | boolean | No | When set to true , the role will be deleted with all it’s assignments. |
Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"message": "Role deleted"
}
Status codes
Code | Description |
---|---|
200 | Role is deleted. |
400 | Bad request (invalid json, missing content-type, missing or invalid fields, etc.). |
403 | Access denied |
500 | Unexpected error. Refer to body and/or server logs for more details. |
Create and remove built-in role assignments
API set allows to create or remove built-in role assignments and list current assignments.
Get all built-in role assignments
GET /api/access-control/builtin-roles
Gets all built-in role assignments.
Required permissions
Action | Scope |
---|---|
roles.builtin:list | roles:* |
Example request
GET /api/access-control/builtin-roles
Accept: application/json
Content-Type: application/json
Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"Admin": [
{
"version": 1,
"uid": "qQui_LCMk",
"name": "fixed:users:org:edit",
"description": "",
"global": true,
"updated": "2021-05-13T16:24:26+02:00",
"created": "2021-05-13T16:24:26+02:00"
},
{
"version": 1,
"uid": "PeXmlYjMk",
"name": "fixed:users:org:read",
"description": "",
"global": true,
"updated": "2021-05-13T16:24:26+02:00",
"created": "2021-05-13T16:24:26+02:00"
}
],
"Grafana Admin": [
{
"version": 1,
"uid": "qQui_LCMk",
"name": "fixed:users:org:edit",
"description": "",
"global": true,
"updated": "2021-05-13T16:24:26+02:00",
"created": "2021-05-13T16:24:26+02:00"
}
]
}
Status codes
Code | Description |
---|---|
200 | Built-in role assignments are returned. |
403 | Access denied |
500 | Unexpected error. Refer to body and/or server logs for more details. |
Create a built-in role assignment
POST /api/access-control/builtin-roles
Creates a new built-in role assignment.
Required permissions
permission:delegate
scope ensures that users can only create built-in role assignments with the roles which have 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 create a built-in role assignment which will allow to do that. This is done to prevent escalation of privileges.
Action | Scope |
---|---|
roles.builtin:add | permissions:delegate |
Example request
POST /api/access-control/builtin-roles
Accept: application/json
Content-Type: application/json
{
"roleUid": "LPMGN99Mk",
"builtinRole": "Grafana Admin",
"global": false
}
JSON body schema
Field Name | Date Type | Required | Description |
---|---|---|---|
roleUid | string | Yes | UID of the role. |
builtinRole | boolean | Yes | Can be one of Viewer , Editor , Admin or Grafana Admin . |
global | boolean | No | A flag indicating if the assignment is global or not. If set to false , the default org ID of the authenticated user will be used from the request to create organization local assignment. Refer to the Built-in role assignments for more information. |
Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"message": "Built-in role grant added"
}
Status codes
Code | Description |
---|---|
200 | Role was assigned to built-in role. |
400 | Bad request (invalid json, missing content-type, missing or invalid fields, etc.). |
403 | Access denied |
404 | Role not found |
500 | Unexpected error. Refer to body and/or server logs for more details. |
Remove a built-in role assignment
DELETE /api/access-control/builtin-roles/:builtinRole/roles/:roleUID
Deletes a built-in role assignment (for one of Viewer, Editor, Admin, or Grafana Admin) to the role with the provided UID.
Required permissions
permission:delegate
scope ensures that users can only remove built-in role assignments with the roles which have 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 remove a built-in role assignment which allows to do that.
Action | Scope |
---|---|
roles.builtin:remove | permissions:delegate |
Example request
DELETE /api/access-control/builtin-roles/Grafana%20Admin/roles/LPMGN99Mk?global=false
Accept: application/json
Query parameters
Param | Type | Required | Description |
---|---|---|---|
global | boolean | No | A flag indicating if the assignment is global or not. If set to false , the default org ID of the authenticated user will be used from the request to remove assignment. Refer to the Built-in role assignments for more information. |
Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"message": "Built-in role grant removed"
}
Status codes
Code | Description |
---|---|
200 | Role was unassigned from built-in role. |
400 | Bad request (invalid json, missing content-type, missing or invalid fields, etc.). |
403 | Access denied |
404 | Role not found. |
500 | Unexpected error. Refer to body and/or server logs for more details. |