subscription.data-governance.configure ​
Configure org-level audit storage and retention policy
Create or update organization-selected audit storage and retention policy.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-subscription |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Organization UUID |
subscription_uuid | uuid | No | — | Subscription UUID for billing attribution |
audit_authorized_read_enabled | boolean | No | — | Persist successful read/list/data authorization checks |
audit_authorized_mutation_enabled | boolean | No | — | Persist successful mutating authorization checks |
audit_authorized_workflow_allowlist | list | No | — | Workflow names whose successful authorization is always stored |
audit_authorized_workflow_denylist | list | No | — | Workflow names whose successful authorization is never stored |
workflow_state_retention_days | integer | No | — | Workflow state retention in days |
workflow_event_retention_days | integer | No | — | Workflow event retention in days |
scheduled_transition_retention_days | integer | No | — | Completed scheduled transition retention in days |
audit_log_retention_days | integer | No | — | Audit log retention in days |
usage_snapshot_retention_days | integer | No | — | Usage snapshot retention in days |
max_retained_workflow_storage_bytes | integer | No | — | Optional workflow storage cap for billing/alerts |
max_retained_audit_storage_bytes | integer | No | — | Optional audit storage cap for billing/alerts |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | — |
subscription_uuid | uuid | No | — | — |
policy | json | No | — | — |
warnings | list | No | — | — |
completed_at | string | No | — | — |
failed_at | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
pending | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "subscription.data-governance.configure",
"initial_data": {
"organization_uuid": "value"
}
}