Permissions
Grant actions to groups, filter readable records, and check authority before a write.
Permissions are granted to security groups. A principal receives access through its group memberships, including its personal group. Organization membership does not automatically grant access to content. Domain-specific evaluators can add rules to the shared behavior below.
PermissibleEntity
PermissionAction
| Action | Purpose |
|---|---|
VIEW | See the entity exists and read its fields |
LIST | List an entity or its items, as defined by the owning API |
EDIT | Modify the entity |
MANAGE | Grant/revoke permissions (implies EDIT) |
DELETE | Soft-delete the entity |
EXECUTE | Execute an operation such as a script, job, or workflow transition |
IMPERSONATE | Act as another principal in this context |
The Decision Chain
When isAllowed(authentication, entity, action) is called:
- Deleted check — access to deleted records requires
hasSaGroup(), which accepts SA or administrators with the required token scope. - Public access — if
publicand published/advertised,VIEWis granted. IfpublicListand published/advertised,LISTis granted. - Token scopes — private access and writes through scoped API tokens must satisfy the evaluator's domain scope rules. Public reads remain independently accessible.
- Editor group — the shared evaluator grants
EDITthroughhasEditorGroup(); domain evaluators can impose additional rules. - Entity-level permissions — checks user's groups against
EntityPermissionrecords.MANAGEalso satisfiesEDIT. - Role-based fallback — the shared evaluator accepts SA and administrators for all actions. Editors and managers satisfy actions other than
MANAGE,EXECUTE, andIMPERSONATE, subject to scope checks. - Parent access — if no earlier rule allows access, the owning permission service evaluates inherited access through
isParentAllowed().
Published vs. Advertised
Advertised is a "soft-public" state — the entity can be found and viewed, but its binary content and supplementary attachments remain restricted.
| What | Required Flag | Required State |
|---|---|---|
| Entity record (title, description) | public = true | published or advertised |
| Entity in list/search results | publicList = true | published or advertised |
| Binary content (file download) | publicContent = true | published only |
| Supplementary attachments | publicSupplementary = true | published only |
In Queries: Filter, Don't Throw
Query fields silently filter unauthorized data to avoid leaking information:
In Mutations: Verify and Throw
Creating New Entities
When creating, check permissions on the parent or require a group:
GroupEvaluator
For operations that don't target a specific entity:
Locked Entities
Collection controllers restrict edits to locked records using hasSaGroup(), which accepts SA or administrators with the required scope: