Get Role Capabilities

See what a role lets its members do in Cirra: web search, files, shell commands, and each app, model, or action.

GET

Path

Path parameters

stringrequired

The role's id, from List Roles.

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Response fields

roleIdstring

The role.

capabilitiesarray of objects

Every rule the role sets, in key order. A key it does not set follows its fallback (Get Capability Catalog).

keystring
The capability key, such as apps.salesforce.contact.delete.
valuestring
allow or deny. A deny is a ceiling no member of the role can lift.
- allow
- deny