listCapabilities

GET

/api/v1/roles/capabilities

const url = 'https://example.com/api/v1/roles/capabilities';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/roles/capabilities

The closed capability vocabulary, with whether the caller may grant each capability in a custom role. Requires users.manage or roles.manage and the admin scope.

Responses

200

Capability vocabulary

application/json

object

data

required

object

items

required

Array<object>

object

key

required

One capability from the server’s closed vocabulary, such as media.upload or playlist.publish. GET /api/v1/roles/capabilities lists them.

string

/^[a-z][a-z0-9_.]{1,63}$/

group

required

string

Allowed values: media widgets dataSources playlists layouts campaigns review screens schedules activity plugins administration

requires

required

Array<string>

ownerReserved

required

Held only by the built-in Owner role.

boolean

delegable

required

False for capabilities that administer access; only the Owner may put them in a custom role.

boolean

grantable

required

Whether the caller may include it in a custom role.

boolean

Example

{
  "data": {
    "items": [
      {
        "group": "media"
      }
    ]
  }
}

401

Dashboard authentication required

403

Insufficient role