Gets available permissions

GET 
<your-unleash-url>/api/admin/permissions

Returns a list of available permissions

Responses

200

adminPermissionsSchema

application/json

Schema

Schema

permissions objectrequired
Returns permissions available at all three levels (root|project|environment)
root object[]
Permissions available at the root level, i.e. not connected to any specific project or environment
Array [
idintegerrequired
The identifier for this permission
Example: 3
namestringrequired
The name of this permission
Example: UPDATE_FEATURE
displayNamestringrequired
The name to display in listings of permissions
Example: Update feature flags
typestringrequired
What level this permission applies to. Either root, project or the name of the environment it applies to
Example: project
environmentstring
Which environment this permission applies to
Example: development
]
project object[]required
Permissions available at the project level
Array [
idintegerrequired
The identifier for this permission
Example: 3
namestringrequired
The name of this permission
Example: UPDATE_FEATURE
displayNamestringrequired
The name to display in listings of permissions
Example: Update feature flags
typestringrequired
What level this permission applies to. Either root, project or the name of the environment it applies to
Example: project
environmentstring
Which environment this permission applies to
Example: development
]
environments object[]required
A list of environments with available permissions per environment
Array [
namestringrequired
The name of the environment
Example: development
permissions object[]required
Permissions available for this environment
Array [
idintegerrequired
The identifier for this permission
Example: 3
namestringrequired
The name of this permission
Example: UPDATE_FEATURE
displayNamestringrequired
The name to display in listings of permissions
Example: Update feature flags
typestringrequired
What level this permission applies to. Either root, project or the name of the environment it applies to
Example: project
environmentstring
Which environment this permission applies to
Example: development
]
]
versionintegerrequired
The api version of this response. A natural increasing number. Only increases if format changes
Possible values: >= 1, [1, 2]
Example: 1

Example (auto)

{
  "permissions": {
    "root": [
      {
        "id": 3,
        "name": "UPDATE_FEATURE",
        "displayName": "Update feature flags",
        "type": "project",
        "environment": "development"
      }
    ],
    "project": [
      {
        "id": 3,
        "name": "UPDATE_FEATURE",
        "displayName": "Update feature flags",
        "type": "project",
        "environment": "development"
      }
    ],
    "environments": [
      {
        "name": "development",
        "permissions": [
          {
            "id": 3,
            "name": "UPDATE_FEATURE",
            "displayName": "Update feature flags",
            "type": "project",
            "environment": "development"
          }
        ]
      }
    ]
  },
  "version": 1
}

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/permissions' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

ResponseClear

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