Get a list of roles | Unleash Documentation

Enterprise feature

Get a list of project, root and custom roles for Role-Based Access Control

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

rolesWithVersionSchema

versioninteger>=1

The version of this schema

roleslist of objects

A list of roles

401

Unauthorized Error

403

Forbidden Error

1	{
2	"version": 1,
3	"roles": [
4	{
5	"id": 9,
6	"type": "root",
7	"name": "Editor",
8	"description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
9	"project": "default"
10	}
11	]
12	}

1	{
2	"version": 1,
3	"roles": [
4	{
5	"id": 9,
6	"type": "root",
7	"name": "Editor",
8	"description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
9	"project": "default"
10	}
11	]
12	}

$	curl https://app.unleash-instance.example.com/api/admin/roles \
>	-H "Authorization: <apiKey>"