Role#
A Role
defines a set of permissions within a particular project. When you create a Role
you need to specify the project it belongs in.
GlobalRole
, by contrast, is not limited to a project scope.
Choose a scope#
There are two different scopes in which you can define a Role, depending on how much you want it to be shared.
- for global scope, use
GlobalRole
- for project scope, use
Role
Project level#
In case you would like to set permissions at Project level, you will need to create a Role
.
Global level#
In case you would like to set permissions at Global level , you will need to create a GlobalRole
.
Role specification#
Permission specification#
# Types of actions the permission grant access
actions:
- <enum= "create" | "read" | "update" | "delete">
# The list of kind targeted by the permission. For example: `Datasource`, `Dashboard`, ...
# With Role, you can't target global kinds
scopes:
- <string>
More info about authorization#
Please look at the documentation to know more about permissions and roles.
API definition#
Role
#
Get a list of Role
#
URL query parameters:
- name =
<string>
: should be used to filter the list of Roles based on the prefix name.
Example:
The following query should return an empty list or a list containing roles.
Get a single Role
#
Create a single Role
#
Update a single Role
#
Delete a single Role
#
GlobalRole
#
Get a list of GlobalRole
#
URL query parameters:
- name =
<string>
: should be used to filter the list of Role based on the prefix name.
Example:
The following query should return an empty list or a list containing global roles.