Update Role Capabilities

Allow or deny what a role's members may do in Cirra, down to a single app action. To restrict one person, give them a role that denies it.

PUT

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.

Body

Arguments

objectrequired

Keys to set, each to allow, deny, or null to clear.

{ capabilityKey: value }: allow, deny, or null to clear the rule so the key follows its fallback. Keys come from Get Capability Catalog.

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