PersesPerses

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.

kind: "Role"
metadata:
  name: <string>
  project: <string>
spec: <Role specification>

Global level#

In case you would like to set permissions at Global level , you will need to create a GlobalRole.

kind: "GlobalRole"
metadata:
  name: <string>
spec: <Role specification>

Role specification#

# List of permissions owned by the role
permissions:
  - <Permission 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#

GET /api/v1/projects/<project_name>/roles

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 /api/v1/projects/<project_name>/roles?name=owner

Get a single Role#

GET /api/v1/projects/<project_name>/roles/<role_name>

Create a single Role#

POST /api/v1/projects/<project_name>/roles

Update a single Role#

PUT /api/v1/projects/<project_name>/roles/<role_name>

Delete a single Role#

DELETE /api/v1/projects/<project_name>/roles/<role_name>

GlobalRole#

Get a list of GlobalRole#

GET /api/v1/globalroles

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.

GET /api/v1/globalRoles?name=admin

Get a single GlobalRole#

GET /api/v1/globalroles/<name>

Create a single GlobalRole#

POST /api/v1/globalroles

Update a single GlobalRole#

PUT /api/v1/globalroles/<name>

Delete a single GlobalRole#

DELETE /api/v1/globalroles/<name>
Edit this page