Gets available permissions

GET /api/admin/permissions

Returns a list of available permissions

Request

Responses

adminPermissionsSchema

application/json

Schema
Example (from 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

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

Gets available permissions

Request​

Request