Gets available permissions

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

Authorization

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

Returns a list of available permissions

Request

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 [

  id integer required

  The identifier for this permission

  name string required

  The name of this permission

  displayName string required

  The name to display in listings of permissions

  type string required

  What level this permission applies to. Either root, project or the name of the environment it applies to

  environment string

  Which environment this permission applies to

  ]

  project object[]required

  Permissions available at the project level

  Array [

  id integer required

  The identifier for this permission

  name string required

  The name of this permission

  displayName string required

  The name to display in listings of permissions

  type string required

  What level this permission applies to. Either root, project or the name of the environment it applies to

  environment string

  Which environment this permission applies to

  ]

  environments object[]required

  A list of environments with available permissions per environment

  Array [

  name string required

  The name of the environment

  permissions object[]required

  Permissions available for this environment

  Array [

  id integer required

  The identifier for this permission

  name string required

  The name of this permission

  displayName string required

  The name to display in listings of permissions

  type string required

  What level this permission applies to. Either root, project or the name of the environment it applies to

  environment string

  Which environment this permission applies to

  ]

  ]
• version integer required

  Possible values: >= 1, [1, 2]

  The api version of this response. A natural increasing number. Only increases if format changes

Example (from schema)

{
  "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

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

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

curl / cURL

curl -L -X GET '<your-unleash-url>/api/admin/permissions' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests

curl -L -X GET '<your-unleash-url>/api/admin/permissions' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

go / native

curl -L -X GET '<your-unleash-url>/api/admin/permissions' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / axios

curl -L -X GET '<your-unleash-url>/api/admin/permissions' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET '<your-unleash-url>/api/admin/permissions' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / RestSharp

curl -L -X GET '<your-unleash-url>/api/admin/permissions' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

php / cURL

curl -L -X GET '<your-unleash-url>/api/admin/permissions' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET '<your-unleash-url>/api/admin/permissions' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET '<your-unleash-url>/api/admin/permissions' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'