Create a new role | Unleash Documentation

Enterprise feature

Create a new custom role 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

createRoleWithPermissionsSchema

objectRequired

roleWithVersionSchema

versioninteger>=1

The version of this schema

rolesobject

A single role

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

$	curl -X POST https://app.unleash-instance.example.com/api/admin/roles \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "external-contributors"
>	}'

1	{
2	"version": 1,
3	"roles": {
4	"id": 9,
5	"type": "root",
6	"name": "Editor",
7	"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.",
8	"project": "default"
9	}
10	}

$	curl -X POST https://app.unleash-instance.example.com/api/admin/roles \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "external-contributors"
>	}'

1	{
2	"version": 1,
3	"roles": {
4	"id": 9,
5	"type": "root",
6	"name": "Editor",
7	"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.",
8	"project": "default"
9	}
10	}