Understand Policy
Understand authoring, governance, revision identity, authorization, and delivery evidence before performing tasks.
Policy connects authored intent to reviewed revisions and target-specific delivery.
The Library helps users find policies and inspect their lifecycle history.
Data and artificial intelligence (AI) authoring capture different protection inputs.
The compiler validates those inputs and prepares target-specific artifacts.
Read by Concern
Choose the reference that matches your question:
Keep Responsibilities Separate
An author can prepare a replacement while an approved revision remains governed.
A reviewer must inspect the current submitted content before deciding.
An operator follows delivery and recovery evidence after governance completes.
An application developer must preserve API errors, identities, and concurrency tokens.
No single status label answers every question.
Refer to states and revisions
before interpreting a policy’s progress.
Continue with Work with policies
or System operations.
1 - Policy Overview
Understand Policy responsibilities and find the appropriate conceptual, workflow, or operational guide.
Policy combines guided authoring, review decisions, governed revisions, and delivery evidence.
Refer to Understand Policy for the canonical conceptual references.
Refer to Start here for an ordered learning path.
Key Capabilities
Policy supports the following responsibilities:
- Find policies and inspect available detail and history through Policy Library.
- Author Data protection or artificial intelligence (AI) policies with lane-specific inputs.
- Save proposed work separately from the current governed revision.
- Submit, request changes, and approve with the appropriate authority.
- Publish approved artifacts and inspect target-specific delivery evidence.
- Refresh approved compilation output through background processing.
Policy Release Highlights
Supported authoring choices and available interface actions depend on your release and authority.
Use the corresponding task guide rather than inferring support from a conceptual example.
The API reference distinguishes operation contracts from interface presentation.
Documented Use Cases
Refer to use cases
for author, reviewer, operator, and integration journeys.
The deployment guides target Kubernetes with the required Protegrity platform integrations.
They do not establish support for arbitrary standalone platform combinations.
System Requirements
Operators need the release’s platform, storage, gateway, identity, and integration prerequisites.
PostgreSQL runs inside the Policy stack.
Authors and reviewers need the capabilities for their assigned tasks.
Refer to installation
and access preparation.
Architecture
Refer to Architecture
for component responsibilities and delivery boundaries.
Definitions
Use these references for shared definitions:
1.1 - Role-Based Access Control and Artificial Intelligence Policies
Distinguish access to Policy from the runtime permissions expressed by an authored policy.
Role-based access control (RBAC) governs access to Policy operations.
An authored artificial intelligence (AI) policy governs a different concern:
runtime behavior for the selected principals and classifications.
Here, runtime means downstream processing of requests or data, not administration of the Policy service.
Do not treat these two permission systems as interchangeable.
RBAC in Policy
The platform authenticates users through its supported gateway integration.
Policy maps trusted authorities to command capabilities.
Editing and rollback also require applicable policy access grants.
The policy_author bundle does not provide review or approval authority.
An owner grant does not add either capability.
Different authenticated users can therefore perform the author and reviewer responsibilities.
This capability separation does not itself enforce mandatory two-person approval.
Refer to roles and permissions
for the canonical role and capability tables.
Refer to API authentication
for the request-level identity contract.
AI Policy in Policy
AI authoring captures classification and principal-specific runtime permissions.
Its permissions matrix describes the selected principals’ allowed behavior.
It does not assign those principals administrative roles in Policy.
For example, a principal can receive a runtime unprotect permission.
Unprotect means allowing supported runtime access to protected content. It does not remove a governed policy.
That permission does not allow the principal to submit or approve a Policy draft.
Likewise, a Policy approver does not automatically receive runtime unprotect access.
Preview output, saved content, approval, and consumer receipt remain distinct checkpoints.
A delivered Federated Guardrails artifact does not prove execution against real traffic.
Refer to validation and review decisions
and delivery verification.
Verification
Verify product access and authored runtime permissions independently.
Refer to authoring procedures
for the selected lane.
Refer to lifecycle and governance
for the review handoff.
2 - States and Revisions
Distinguish draft work, governed revisions, compilation minors, and target-specific delivery evidence.
A policy can have governed content and an open replacement draft simultaneously.
Saving that replacement does not make it the approved policy.
Publication and observed protection remain separate from both authoring and approval.
Three Independent Questions
The following table distinguishes the questions answered by draft, governance, and delivery evidence:
| Concern | Question | Relevant Information |
|---|
| Draft work | What proposal can the author edit or submit? | Inspect draft identity, current snapshot, and draft status. |
| Governance | Which content has completed approval? | Inspect the governed revision and its approval history. |
| Delivery and protection | What happened at the intended targets? | Check the latest operation and the Data observations or Guardrails consumer receipt. |
Before first approval, no governed revision or protection evidence may exist.
An empty protection value does not mean protection succeeded or failed.
Do not derive these independent concerns from one displayed status.
Drafts and Saved Snapshots
The policy identifier remains stable across its lifecycle.
A draft identifies proposed work for that policy.
Each successful save creates a retained snapshot of that work.
Repeated saves do not create repeated governed revisions.
The draft head is its current saved snapshot, not the governed revision.
A snapshot records saved content. The draft’s head changes when later work supersedes it.
Submission puts the current proposal into review.
A request for changes returns editable work with the reviewer’s reason.
The author can correct that proposal and submit it again.
Reviewing a draft does not publish its contents.
Governed Revisions and Compilation Minors
Approval creates a governed revision from the exact reviewed draft.
It also starts asynchronous delivery work.
A later authored replacement must pass through the review workflow again.
Automatic recompilation serves a different purpose.
It recompiles approved intent against fresh context without requiring author edits.
Changed output creates a compilation minor under the governed revision.
Approved intent means the reviewed classifications, principals, methods, and permission selections.
A compilation minor changes generated target configuration, not those authored selections.
It preserves the original approval identity and leaves open drafts unchanged.
Unchanged output creates no compilation minor or publication work.
For example:
- Alex saves and submits a draft.
The draft remains proposed work until an authorized approval succeeds.
- Morgan approves the current submission.
Policy creates the first governed revision and queues publication.
- A later automatic cycle detects changed compilation output.
Policy records a compilation minor and queues new delivery work.
- Alex edits the authored policy.
The new draft remains separate from the governed revision and its compilation minors.
Refer to automatic recompilation
for scheduling, failures, and observation.
Delivery Generations and Evidence
A deployment generation identifies a particular publication or withdrawal operation.
A retry continues retained work for that generation.
It does not approve new authored content or substitute a corrected draft.
The deployment identifier selects the retained operation. Its generation distinguishes successive publication or withdrawal operations for the policy.
Inspect operation history rather than deriving either value from the governed revision number.
For Data protection, verify the expected location scope and positive protection observations.
For Federated Guardrails, a consumer receipt records retrieval of the currently generated configuration.
A receipt does not prove execution against real traffic or activation by every replica.
A policy using both targets needs complete Data observations and the matching Guardrails receipt.
Publication failure does not undo the approval that created the governed revision.
Withdrawal can also remain incomplete after an archive request succeeds.
Do not treat archive acceptance as completed deprotection.
Concurrency Tokens Identify Different Resources
Application programming interface (API) clients must retain server-issued validators.
An entity tag (ETag) is an opaque validator for one resource version.
Send the exact value, including quotes, in the operation’s required If-Match header.
It is not an authentication token, policy identifier, or interchangeable revision number.
The table identifies each resource’s validator and the distinction API clients must preserve:
| Resource | Validator | Required Distinction |
|---|
| Current draft | Draft-ETag, supplied as If-Match for draft commands | Re-read after save, submit, or review decisions. |
| Governed policy | Policy ETag for archive | Do not substitute the draft token. |
| Ownership registry | Registry ETag for reconciliation decisions | Do not substitute a policy or draft token. |
The API reference
defines each operation’s exact token and error contract.
Continue with lifecycle and governance
for the author and reviewer tasks.
3 - Roles and Permissions
Distinguish authentication, command capabilities, policy access grants, and downstream authority.
Authentication establishes who is making a request.
Authorization determines whether that identity can perform the requested operation.
Some commands also require access to the particular policy.
A command capability answers whether an identity may perform an operation at all.
A policy access grant answers whether that operation may affect this specific policy.
Commands that require both checks must satisfy both.
Responsibilities Are Not New Roles
An author prepares and submits proposed work.
A reviewer inspects a submission and can request changes with the required authority.
An approver accepts the reviewed content with approval authority.
An operator observes delivery and performs specifically authorized recovery tasks.
One person can hold multiple responsibilities.
Different users can also perform them with separate authenticated accounts.
The capability model does not itself enforce mandatory two-person approval.
There is no separate policy_reviewer role in the role bundles below.
Product Role Bundles
The following table summarizes each product role bundle and its key limitation:
| Role | Capability Scope | Important Limit |
|---|
policy_viewer | Grant policy:view. | Do not assume edit, review, approval, or restricted diagnostic access. |
policy_author | Add edit, rollback, compile, and preview capabilities. | Require an applicable policy grant for ordinary edit and rollback. Do not grant review or approval. |
policy_admin | Add review, approval, archive, audit, system configuration, and observability. | Do not treat this broad bundle as the default way to grant one responsibility. |
Platform permissions can map to capabilities separately from these role bundles.
Their membership does not necessarily match the product bundles exactly.
Ask the platform administrator to verify the effective authorities for your task.
Unknown authorities do not create capabilities.
An authority is a permission asserted by the trusted platform gateway.
It is not a request field that clients may choose for themselves.
Command Capabilities
Use this table to identify the capability and policy boundary for each task:
| Task | Required Capability | Additional Boundary |
|---|
| Create, edit, or submit authored work | policy:edit | Require the applicable policy access grant for existing-policy edits and submission. |
| Roll back authored work | policy:rollback | Require the applicable policy access grant. |
| Refresh saved validation or request changes | policy:review | Do not substitute author ownership for review authority. |
| Approve a submission | policy:approve | Review the current draft and use its current concurrency token. |
| Archive a policy | policy:archive | Use the governed-policy validator and provide a reason. |
| Inspect retained operations or restricted validation diagnostics | policy:audit | Do not assume a support reference grants access. |
| Reconcile native ownership | policy:system-configure | Require additional archive authority for withdrawal decisions. |
| Inspect operational metrics | policy:observability | Do not assume system configuration authority includes metrics access. |
Retry authority follows the retained operation.
Publishing retry requires approval authority. Withdrawal retry requires archive authority.
Refer to recovery and reconciliation
for the complete operation-specific rules.
Policy Access Grants
An owner or editor grant determines access to particular authored work.
It does not create review, approval, archive, or system configuration capabilities.
An author role also does not automatically grant edit access to every policy.
For example, policy:edit without an applicable owner/editor grant does not authorize an existing-policy edit.
An owner grant without policy:approve does not authorize approval.
Refer to policy access management
for grant changes.
Do not remove the last active owner during routine access maintenance.
Administrator recovery is a separate audited path, not an ordinary grant substitute.
Identity and Downstream Access
Use the supported platform sign-in or gateway authentication path.
Policy records the authenticated actor. Clients must not impersonate another reviewer.
Do not supply submittedBy or approvedBy as a workaround.
Policy authority does not automatically create permission in a downstream system.
An operator may need separate integration and target access.
Refer to security settings
and API authentication.
Continue with lifecycle and governance.
4 - Classifications, Principals, and Methods
Understand how catalog-backed authoring choices define policy scope and target-specific behavior.
Authoring combines the data or runtime scope with intended principals and permissions.
Catalog choices have operational meaning. They are not interchangeable display labels.
Classifications and Scope
A classification identifies a category of discovered data.
For Data protection, its resolved locations determine where protection applies.
Review that scope before submission, particularly after catalog changes.
The same display name does not prove the same current location set.
Scope is the resolved set of locations or runtime subjects to which the selected inputs apply.
Record identifiers and representative locations, not just a classification’s display name.
An empty selection and an unresolved classification are different problems.
An empty selection supplies no classification.
An unresolved classification supplies an identifier that current discovery cannot match to the required input.
Correct the selected input when it is wrong.
Ask an operator to inspect discovery when expected catalog data is missing.
Principals and Permissions
A principal identifies an intended runtime subject, such as a configured group.
Select it from the available catalog and verify its intended membership.
Do not confuse a policy’s runtime principals with the users administering Policy.
For example, an application group may receive an unprotect permission.
That permission does not allow the group to approve Policy drafts.
Conversely, approval authority does not automatically grant runtime data access.
Protection Methods and Authoring Lanes
Data authoring captures protection choices supported by the selected release and target.
Artificial intelligence (AI) authoring uses its own principal-permission matrix.
Do not infer that every method listed in a catalog supports both lanes.
Do not treat hidden, unsupported, or unavailable choices as tutorial prerequisites.
Preview helps inspect target-specific output.
Saving retains authored inputs, including supported incomplete work.
Submission and approval require current validation and the appropriate review decisions.
Changing Context
Discovery, configured identities, and native target inventory can change over time.
Policy therefore validates current context during governance operations.
Automatic recompilation can also generate updated artifacts from approved intent.
Neither mechanism authorizes silently changing an author’s proposed policy.
Continue with Data and AI authoring
or validation and review decisions.
5 - Validation and Review Decisions
Distinguish saving, previewing, validating, acknowledging conflicts, approving, and verifying delivery.
Each checkpoint answers a different question about a policy.
A successful earlier checkpoint does not guarantee success at the next one.
Checkpoint Meanings
The following table explains what each checkpoint establishes and what to verify next:
| Checkpoint | What It Establishes | What Remains to Check |
|---|
| Save | Retain accepted authored input as a draft snapshot. | Resolve incomplete or invalid work before submission. |
| Preview | Inspect target-specific compilation output for the supplied input. | Save the intended content and validate its current context. |
| Saved validation | Check the latest saved draft for an authorized reviewer. | Correct blocking findings or review conflicts that permit acknowledgement. |
| Submit | Accept eligible current draft work into review. | Obtain the authorized review decision. |
| Approve | Commit the reviewed governed revision and queue delivery. | Verify publication and target-specific protection evidence. |
| Publication | Deliver generated configuration to the receiving product. | Follow the Data or Guardrails verification guide. |
Blocking and Reviewable Findings
Some findings require correction before the operation can continue.
Other findings permit an explicitly recorded review acknowledgement.
An acknowledgement records an authorized acceptance of a specifically reviewable finding.
It does not suppress validation, widen permissions, or override a blocking finding.
Use the returned conflict identifiers and the current operation contract.
Do not acknowledge every finding merely to make a request succeed.
Review notes explain an approval.
A request-changes reason explains what the author must correct.
Neither text field replaces a missing capability or stale concurrency token.
Fresh Validation and Stale Work
Current dependencies can change after a preview or earlier save.
That context includes discovered locations, identity metadata, and current native target inventory.
Submission and approval therefore validate current inputs and governed context.
A reviewer must load the submitted draft and its current validation results before approving.
If a command reports changed work, refresh the policy and review the new content.
Do not blindly replace the token and replay a consequential decision.
Refer to API error handling.
Diagnostics and Escalation
An error can provide a support reference without disclosing restricted diagnostics.
An ordinary author may need an authorized operator to inspect that reference.
Record the operation, policy identifier, time, and safe error details.
Never include access tokens or sensitive payload values in a support request.
The reference identifies retained evidence. It neither contains that evidence nor grants permission to read it.
Refer to diagnostics
for evidence collection and access boundaries.
Continue with lifecycle and governance.
6 - Policy Terminology
Define the identities, revision records, delivery evidence, and recovery terms used throughout Policy.
Policy uses different records for authored work, approved content, and target delivery.
Similar names do not make those records interchangeable.
This reference explains the distinctions used in task instructions and error messages.
Authoring and Governance
The following table defines terms for authoring and governance:
| Term | Meaning and Boundary |
|---|
| Authored intent | Describe the author’s selected classifications, principals, methods, and permissions, before target-specific compilation. |
| Authoring lane | Distinguish Data authoring from artificial intelligence (AI) authoring. Their inputs and supported protection choices differ. |
| Classification | Identify a category of discovered data. Its current resolved locations determine Data scope. |
| Scope | Identify the data locations or runtime subjects affected by the selected policy inputs. A display name alone does not establish scope. |
| Principal | Identify a runtime subject, such as a configured directory group. Do not confuse it with the person administering Policy. |
| Draft | Hold proposed policy work that can proceed through saving, submission, review, and approval. |
| Draft identity and cycle | Keep the stable draftPolicyId separate from its cycleNumber. A later authoring cycle can retain the same draft identity. |
| Snapshot | Retain a particular saved state of authored work. Saving again does not create another approved revision. |
| Draft head | Identify the draft’s current saved snapshot. Inspect its current status and validator before changing it. |
| Governed revision | Record content that completed approval. An open replacement draft does not replace this content. |
| Compilation minor | Record changed compiled output under an existing governed revision without changing its authored intent or approval attribution. |
| Review acknowledgement | Record an authorized acceptance of a specifically reviewable finding. Do not use it to bypass a blocking conflict. |
For example, saving a corrected draft changes proposed work.
Approval creates governed content.
Automatic recompilation can then change generated output without another author edit.
Refer to states and revisions.
Identity and Request Evidence
The following table defines identity and request-evidence terms:
| Term | Meaning and Boundary |
|---|
| Authentication token | Establish the caller’s authenticated identity through the supported gateway. Keep it secret. |
| Authority | Identify a permission asserted by the trusted platform. Clients must not invent identity or authority headers. |
| Command capability | Permit an operation, such as policy:approve. Ownership of a policy does not supply that capability. |
| Policy access grant | Assign owner or editor access to particular authored work. Commands can also require a separate capability. |
| Entity tag (ETag) | Identify an opaque server-issued resource validator. Send its exact quoted value in the required If-Match header. |
| Idempotency key | Identify one exact reconciliation decision for safe replay after an uncertain response. Do not reuse it for different intent or evidence. |
| Service user | Authenticate background integration calls. Keep this identity separate from human users and Kubernetes workload identities. |
pmx_app | Name a fixed PostgreSQL NOLOGIN permission role inherited by the runtime login. It is not another account requiring a password. |
| Identity provider (IdP) | Supply directory or identity-source information. Shared connection metadata does not grant Policy command authority. |
An application programming interface (API) request can require authentication,
a command capability, a policy grant, and a resource validator.
Each satisfies a different condition.
Refer to roles and permissions
and API authentication.
Compilation, Delivery, and Protection
The following table defines compilation, delivery, and protection terms:
| Term | Meaning and Boundary |
|---|
| Compilation | Convert policy intent and current source context into target-specific configuration. |
| Artifact | Hold generated target configuration, not an editable draft or proof of active protection. |
| Publication | Deliver approved artifacts to the relevant integration. Verify the operation’s required completion evidence separately. |
| Deployment generation | Number successive publication or removal requests for a policy. Retry keeps the same generation and increases the attempt count. |
| Outbox | Retain queued publication or withdrawal work durably in Policy’s database. A queued event is not completed delivery. |
| Worker lease | Reserve queued work for a worker for a limited time. Expiry can delay reassignment after process loss. |
| Terminal operation | Stop ordinary automatic processing after failure. Use the permitted recovery path rather than assuming a restart retries it. |
| Consumer receipt | Record a matching consumer read of the artifact. Do not treat it as proof of activation, real-traffic enforcement, or every replica’s receipt. |
| Protection evidence | Establish the applicable target-specific result, such as current positive Data observations. Healthy services alone do not provide it. |
| Fail-closed recompilation | Keep the last accepted configuration when fresh inputs or validation fail. Do not automatically deny all traffic. |
Refer to background processing
and delivery verification.
Ownership and Recovery
The following table defines ownership and recovery terms:
| Term | Meaning and Boundary |
|---|
| Native object | Identify an object in a target product, such as Policy Workbench, rather than a Policy draft or governed revision. |
| Ownership binding | Connect a saved Policy reference to a native object’s unique identifier. Names and reference keys do not substitute for that identifier. |
| Stale validator | Describe request evidence that no longer matches the current resource. Re-read and review before deciding again. |
| Stale binding | Describe a saved ownership mapping whose native object may be absent. Complete inventory and blocker checks must establish cleanup safety. |
| Deployment retry | Resume delivery of configuration saved for a failed request, without compiling later draft edits or fresh discovery. |
| Ownership reconciliation | Choose which Policy Integration Manager (PIM) object Policy associates with a saved reference, using the inspection response and system-configuration permission. |
| Policy rollback | Start an In Review draft from a prior governed revision. Do not treat it as immediate target replacement, database recovery, or Helm rollback. |
| Database restore | Replay a selected backup into the in-stack database under an approved recovery plan. External target changes require separate reconciliation. |
| Release qualification | Confirm compatible chart, API, Panel, PostgreSQL, and storage versions, including a tested migration and restore procedure. |
For recovery actions and authority requirements, use the
recovery directory.
For installation limitations, consult known issues.