Skip to content
Esc
↑↓navigate↵open⌘Jpreview
On this page

Permissions

The permissions a role or an API key grants.

Roles and API keys grant permissions. Each permission is a verb its holder can perform anywhere in a Workspace. Users hold the permissions of their role, and an API key holds those named at its creation, such as with auth create-key. Its creator must hold each one.

  • queries:invoke: Calling a Query by its name or with its code in the call.
  • mutations:invoke: Calling a Mutation.
  • actions:invoke: Running an Action.
  • objects:read: Reading an Object type’s definition.
  • objects:write: Creating, changing, or removing an Object type with Apply.
  • tables:read: Reading a Table’s definition.
  • tables:write: Creating, changing, or removing a Table with Apply.
  • datasets:read: Reading a Dataset’s definition.
  • datasets:write: Creating, changing, or removing a Dataset with Apply, and starting its build or pin.
  • queries:read: Reading a Query’s definition.
  • queries:write: Creating, changing, or removing a Query with Apply.
  • mutations:read: Reading a Mutation’s definition.
  • mutations:write: Creating, changing, or removing a Mutation with Apply.
  • actions:read: Reading an Action’s definition, and its logs: who called it, when, its input, and its result.
  • actions:write: Creating, changing, or removing an Action with Apply.
  • secrets:read: Reading a Secret’s definition and the history of who set its value, but never the value.
  • secrets:write: Creating, changing, or removing a Secret with Apply, and setting or rotating its value.
  • markings:read: Reading a Marking’s definition.
  • markings:write: Creating, changing, or removing a Marking with Apply.
  • connectors:read: Reading a Connector’s definition, and whether it is connected.
  • connectors:write: Creating, changing, or removing a Connector with Apply, and connecting or disconnecting it.
  • apps:read: Reading an App’s definition.
  • apps:write: Creating, changing, or removing an App with Apply, and deploying its App Bundle.
  • egress:manage: Changing the sites an Action can call.
  • markings:manage: Granting Markings, and lowering the Markings data requires through Apply.
  • identity:manage: Managing SSO and Directory Sync, and a Workspace’s users and service users.
  • account:manage: Managing the parent Account of the credential’s Workspace.