Gets available permissions

GET 
/api/admin/permissions

Returns a list of available permissions

Responses

200

adminPermissionsSchema

application/json

Schema

Schema

permissions

object

required

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 integerrequired

The identifier for this permission

Example: 3

name stringrequired

The name of this permission

Example: UPDATE_FEATURE

displayName stringrequired

The name to display in listings of permissions

Example: Update feature flags

type stringrequired

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

Example: project

environment string

Which environment this permission applies to

Example: development

]

project

object[]

required

Permissions available at the project level

Array [

id integerrequired

The identifier for this permission

Example: 3

name stringrequired

The name of this permission

Example: UPDATE_FEATURE

displayName stringrequired

The name to display in listings of permissions

Example: Update feature flags

type stringrequired

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

Example: project

environment string

Which environment this permission applies to

Example: development

]

environments

object[]

required

A list of environments with available permissions per environment

Array [

name stringrequired

The name of the environment

Example: development

permissions

object[]

required

Permissions available for this environment

Array [

id integerrequired

The identifier for this permission

Example: 3

name stringrequired

The name of this permission

Example: UPDATE_FEATURE

displayName stringrequired

The name to display in listings of permissions

Example: Update feature flags

type stringrequired

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

Example: project

environment string

Which environment this permission applies to

Example: development

]

]

version integerrequired
The api version of this response. A natural increasing number. Only increases if format changes
Possible values: >= 1, [1, 2]
Example: 1

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
}

Loading...