ObjectStackObjectStack
ReferenceSecurity Protocol

Queue schema — Security Protocol reference

Queue schemas of the ObjectStack Security Protocol: DeclaredQueueMember, Queue, QueueMemberType — each property with its type, default and a TypeScript example.

Source: packages/spec/src/security/queue.zod.ts

TypeScript Usage

import { DeclaredQueueMemberSchema, QueueSchema, QueueMemberType } from '@objectstack/spec/security';
import type { DeclaredQueueMember, Queue, QueueMemberType } from '@objectstack/spec/security';

// Validate data
const result = DeclaredQueueMemberSchema.parse(data);

DeclaredQueueMember

Properties

PropertyTypeRequiredDescription
type'position'✅The member kind. A declared queue names positions only ('position').
valuestring✅The position machine name whose holders are members of the queue

Queue

Properties

PropertyTypeRequiredDescription
namestring✅Queue machine name (lowercase snake_case); the one name the queue column, an assignment rule, an approver and a sharing recipient reference it by
labelstring✅Display label (e.g. Support Intake)
descriptionstringoptionalAdministrative notes
members{ type: 'position'; value: string }[]optional (default: [])The positions whose holders are members, resolved in the organization a record or request belongs to. An empty list is a queue nobody staffs yet: records still sit in it.
_lockEnum<'none' | 'no-overlay' | 'no-delete' | 'full'>optionalItem-level lock — controls overlay & delete (ADR-0010).
_lockReasonstringoptionalHuman-readable reason shown when a write is refused by _lock.
_lockSourceEnum<'artifact' | 'package' | 'env-forced'>optionalLayer that set _lock (artifact | package | env-forced).
_provenanceEnum<'package' | 'org' | 'env-forced'>optionalOrigin of the item (package | org | env-forced).
_packageIdstringoptionalOwning package machine id.
_packageVersionstringoptionalOwning package version.
_lockDocsUrlstringoptionalOptional documentation link surfaced next to _lockReason.

Nested Shape: Queue.members[number]

PropertyTypeRequiredDescription
type'position'✅The member kind. A declared queue names positions only ('position').
valuestring✅The position machine name whose holders are members of the queue

QueueMemberType

Allowed Values

  • user
  • team
  • position
  • unit_and_subordinates
  • business_unit

Permission

Permission schemas of the ObjectStack Security Protocol: AdminScope and 5 more — each property with its type, default and a TypeScript example.

Rls

Implements fine-grained record-level access control inspired by PostgreSQL RLS and Salesforce Criteria-Based Sharing Rules.

On this page

TypeScript UsageDeclaredQueueMemberPropertiesQueuePropertiesNested Shape: Queue.members[number]QueueMemberTypeAllowed Values