Create a new role

POST 
<your-unleash-url>/api/admin/roles

Create a new custom role for Role-Based Access Control

Request

Responses

200

roleWithVersionSchema

400

The request data does not match what we expect.

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

409

The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/admin/roles' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-d '{
  "name": "external-contributors",
  "description": "Users with external-contributors role have limited access to most features in Unleash",
  "type": "root-custom",
  "permissions": [
    {
      "name": "CREATE_PROJECT",
      "environment": "development"
    }
  ]
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Body required

{
  "name": "external-contributors",
  "description": "Users with external-contributors role have limited access to most features in Unleash",
  "type": "root-custom",
  "permissions": [
    {
      "name": "CREATE_PROJECT",
      "environment": "development"
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!