AdminCapabilityDto

Example

JSON

{
  "key": "string",
  "description": "string",
  "category": "string",
  "product": "console",
  "scope": "account",
  "ownerOnly": false
}

Properties

6 properties 6 required

key string Required

Capability key stored on an administrator role

description string Required

Human-readable description of the capability

category string Required

Display grouping for the role editor

product enum Required

Which product's UI surfaces this capability. Independent of `category` — `audit.view` is Security by subject and opens in the Developer Console.

Enumconsoleworkspace

scope enum Required

Where this capability can be granted. `account` capabilities are held account-wide; `environment` capabilities are granted in one Environment, optionally narrowed to a hierarchy node. A role carries capabilities of exactly one scope.

Enumaccountenvironment

ownerOnly boolean Required

Never delegable to any role — held only by account ownership. Excluded from this list unless `include_owner_only=true`, since a role cannot be composed from one.

Was this page helpful?

Tell us how we can improve this guide.