Validate a role

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

Check if the role matches schema and has a unique name

Request

Responses

200

This response has no body.

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.

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/validate' \
-H 'Content-Type: 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!