Skip to main content

Grant Actions Reference

Complete reference of all permission grant actions supported by the epilot permissions system. See Permissions for concepts and evaluation rules.

Actions follow a {domain}:{operation} pattern. Use {domain}:* to grant all operations in a domain.

Entityโ€‹

Entity permissions are scoped per schema using the resource field (e.g. contact:*, opportunity:*).

ActionDescription
entity:*All entity operations
entity:viewView entities
entity:createCreate entities (also "Upload Files" for file entities)
entity:editEdit entities
entity:bulk_editBulk edit entities
entity:deleteDelete entities
entity:exportExport entities
entity:importImport entities
entity:downloadDownload files
entity:generate_documentGenerate documents
entity:save_document_templateSave new document templates
entity:deduplicateDeduplicate entities (contact, account only)
entity:invite_partnerInvite partners

Entity Attributesโ€‹

Attribute-level permissions control visibility of individual fields. Resources follow the pattern {schema}:{group}:{attribute}.

ActionDescription
entity:attribute:viewView specific entity attributes
entity:attribute:editEdit specific entity attributes
entity:attribute:*All attribute operations

Resource pattern examples:

PatternMatches
contact:*:*All attributes on contacts
contact:Personal Details:emailThe email field in the Personal Details group on contacts
*:*:_tagsThe _tags field across all schemas and groups
*All attributes on all schemas
note

System metadata fields (_id, _title, _org, _schema, _created_at, _updated_at, _tags, _purpose, _owners, _acl, _manifest) are always returned regardless of attribute permissions.

Entity Capabilitiesโ€‹

ActionDescription
entity:capability:*All capability operations
entity:capability:viewView capabilities (e.g. product items on orders)
entity:capability:createCreate capability items
entity:capability:editEdit capability items
entity:capability:deleteDelete capability items

Messagingโ€‹

ActionDescription
message:*All messaging operations
message:viewView messages
message:sendSend messages
message:bulk_sendSend bulk messages
message:deleteDelete messages
info

message:view and message:send implicitly depend on entity:view / entity:* for message and thread entity schemas.

Workflowsโ€‹

Workflow Definitionsโ€‹

ActionDescription
workflow:definition:*All workflow definition operations
workflow:definition:viewView workflow definitions
workflow:definition:createCreate workflow definitions
workflow:definition:editEdit workflow definitions
workflow:definition:deleteDelete workflow definitions

Workflow Executionโ€‹

ActionDescription
workflow:execution:*All workflow execution operations
workflow:execution:viewView all tasks from workflows
workflow:execution:triggerTrigger workflows
workflow:execution:cancelCancel or reopen workflows
workflow:execution:deleteDelete workflows
workflow:execution:update_detailsUpdate workflow assignee and due dates
workflow:execution:task:view_assignedView only assigned tasks
workflow:execution:task:updateUpdate task status
workflow:execution:task:update_assignedUpdate assigned task status only
workflow:execution:task:assignAssign workflow tasks
workflow:execution:task:update_dateSet or change task due date
workflow:execution:task:addAdd new tasks
workflow:execution:task:notesView, create, edit and delete notes in tasks

Automationโ€‹

ActionDescription
automation:*All automation operations
automation:viewView automation flows
automation:createCreate automation flows
automation:editEdit automation flows
automation:deleteDelete automation flows
automation:triggerTrigger automations

Users & Rolesโ€‹

Usersโ€‹

ActionDescription
user:*All user operations
user:viewView users
user:inviteInvite users
user:deleteDelete users

Rolesโ€‹

ActionDescription
role:*All role operations
role:viewView roles
role:assignAssign roles to users
role:createCreate roles
role:deleteDelete roles

Groupsโ€‹

ActionDescription
group:*All group operations
group:viewView groups
group:createCreate groups
group:editEdit groups
group:deleteDelete groups

Access Tokensโ€‹

ActionDescription
token:*All token operations
token:createCreate access tokens

Partner Usersโ€‹

ActionDescription
partner:user:*All partner user operations
partner:user:viewView partner users
partner:user:createCreate partner users
partner:user:update_rolesUpdate partner user roles
partner:user:deleteDelete partner users
partner:user_limit:setSet partner user limit

Organizationโ€‹

ActionDescription
organization:*All organization operations
organization:editUpdate organization
organization:settingsUpdate organization settings
organization:ssoConfigure SSO

Schema & Entity Builderโ€‹

ActionDescription
schema:*All schema operations
schema:viewView entity schemas
entity_manager:*All entity manager operations
entity_manager:viewView entity manager

Emailโ€‹

Email Settingsโ€‹

ActionDescription
email_setting:*All email settings operations
email_setting:viewView email settings
email_setting:createCreate email settings
email_setting:editEdit email settings
email_setting:deleteDelete email settings

epilot Email Addressesโ€‹

ActionDescription
epilot_email_address:*All epilot email address operations
epilot_email_address:viewView epilot email addresses
epilot_email_address:editEdit epilot email addresses

Portalsโ€‹

Customer Portalโ€‹

ActionDescription
customer_portal:*All customer portal operations
customer_portal:viewView customer portals
customer_portal:createCreate customer portals
customer_portal:editEdit customer portals
customer_portal:activateActivate customer portals
customer_portal:deleteDelete customer portals

Installer Portalโ€‹

ActionDescription
installer_portal:*All installer portal operations
installer_portal:viewView installer portals
installer_portal:createCreate installer portals
installer_portal:editEdit installer portals
installer_portal:activateActivate installer portals
installer_portal:deleteDelete installer portals

Webhooksโ€‹

ActionDescription
webhook:*All webhook operations
webhook:viewView webhooks
webhook:createCreate webhooks
webhook:editEdit webhooks
webhook:deleteDelete webhooks

Integrationsโ€‹

ActionDescription
integration:*All integration operations
integration:viewView integrations
integration:manageManage integrations

Dashboardโ€‹

ActionDescription
dashboard:*All dashboard operations
dashboard:createCreate dashboards
dashboard:editEdit dashboards
dashboard:deleteDelete dashboards

Design Builderโ€‹

ActionDescription
design:*All design operations
design:viewView designs
design:createCreate designs
design:editEdit designs
design:deleteDelete designs

Label Builderโ€‹

ActionDescription
label_builder:*All label builder operations
label_builder:viewView label builder
label_builder:createCreate families, labels, and file collections
label_builder:editEdit families, labels, and file collections
label_builder:deleteDelete families, labels, and file collections
label_builder:create_standalone_labelsCreate standalone labels

Variablesโ€‹

ActionDescription
variable:*All variable operations
variable:viewView variables
variable:createCreate variables
variable:editEdit variables
variable:deleteDelete variables

Kanbanโ€‹

ActionDescription
kanban:*All kanban operations
kanban:viewView kanban boards
kanban:all_assignee_filtersFilter by all assignees
kanban:set_org_default_boardSet default board for organization

Appsโ€‹

ActionDescription
app:*All app operations
app:viewView app installations
app:installInstall apps
app:uninstallUninstall apps

Blueprintsโ€‹

ActionDescription
blueprint:*All blueprint operations
blueprint:viewView blueprints
blueprint:installInstall blueprints

Event Catalogโ€‹

ActionDescription
event_catalog:*All event catalog operations
event_catalog:viewView event catalog
event_catalog:manageManage event catalog

Data Managementโ€‹

ActionDescription
data_management:*All data management operations
data_management:viewView data management configuration
data_management:editEdit data management configuration

Datalakeโ€‹

ActionDescription
datalake:*All datalake operations
datalake:viewView datalake settings

Environments & Secretsโ€‹

ActionDescription
environments:*All environment operations
environments:editManage environments and secrets
environments:deleteDelete environments and secrets

File Collectionsโ€‹

ActionDescription
file_collection:*All file collection operations
file_collection:viewView personal file collections
file_collection_builder:*All file collection builder operations
file_collection_builder:viewView file collection builder

Meter Readingโ€‹

ActionDescription
meter_reading:*All meter reading operations
meter_reading:viewView meter readings
meter_reading:createCreate meter readings
meter_reading:editEdit meter readings
meter_reading:activateActivate meter readings
meter_reading:deleteDelete meter readings

Audit Logsโ€‹

ActionDescription
audit_log:viewView audit logs

Notesโ€‹

ActionDescription
note:*All note operations

See Alsoโ€‹