Playground

Playground

Policy

/api/v1/policies/policies

A versioned governance policy document with an owner, category, and review cadence.

listgetcreateupdatedeletepublishretire

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidFK → UserUser id from the caller's JWT (sub).
updated_byuuidFK → UserUser id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidFK → UserUser id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
name*stringHuman-readable policy name (e.g. 'Acceptable Use Policy').
bodystringFull policy text (markdown).
versionstringPolicy version identifier (e.g. '1.2.0'). Bump on material edits.
categoryenumsecurity | privacy | hr | compliance | finance | operations | otherPolicy domain / category.
statusenumdraft | in_review | approved | published | retiredLifecycle state.
owner_iduuidFK → UserPolicy owner (user id).
published_atdate-timeTimestamp the policy was formally published. Stamped automatically by the publish action.
next_review_atdate-timeNext scheduled review date.
tagsjsonFree-form tags for categorizing or searching the policy.

API

client.policies.policy.*
Loading manifest…