Get a single role | Unleash Documentation

Enterprise feature

Get a single role by role id

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

roleIdstringRequired

roleWithPermissionsSchema

iddouble

The role id

typestring

A role can either be a global root role, or a project role or a custom project role or a custom global root-custom role

namestring

The name of the role

permissionslist of objects

A list of permissions assigned to this role

descriptionstring

A more detailed description of the role and what use it's intended for

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

1	{
2	"id": 9,
3	"type": "root",
4	"name": "Editor",
5	"permissions": [
6	{
7	"id": 3,
8	"name": "UPDATE_FEATURE",
9	"displayName": "Update feature flags",
10	"type": "project",
11	"environment": "development"
12	}
13	],
14	"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."
15	}

1	{
2	"id": 9,
3	"type": "root",
4	"name": "Editor",
5	"permissions": [
6	{
7	"id": 3,
8	"name": "UPDATE_FEATURE",
9	"displayName": "Update feature flags",
10	"type": "project",
11	"environment": "development"
12	}
13	],
14	"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."
15	}

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