docs: explain how PII anonymization works and how to control it - #161
Merged
Merged
Conversation
- New page docs/auth/anonymization: when anonymization applies (token
flag vs ?anonymize=true), which APIs enforce it, how values are masked,
the classification order, what is NOT anonymized (best effort), and how
to control it with data_classification in the Entity Builder
("Anonymize" checkbox) or the Entity API.
- Access tokens: document read-only and anonymized tokens.
- CLI: document `epilot auth login --anonymize`.
- Entity attributes: document `data_classification`.
- Agent toolkit: link the new page, warn against writing through
anonymized connections.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01W6dmanYSntb6SZZmQ3QfJK
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Anonymize mode can give a false sense of security: it is best effort, and custom attributes usually aren't masked unless they're classified. This adds one page that explains how it actually works, and links to it from the places that mention anonymization.
docs/auth/anonymization.md(/docs/auth/anonymization, under Auth & Security). It covers:anonymize: true(forced, one-way) vs?anonymize=true(the caller opts in).x-epilot-anonymizedheader, blocks exports) and the Audit Log API (heuristics only). APIs that read entities with the caller's token inherit it. Other APIs don't anonymize.data_classification: pii | public, the Entity Builder Anonymize checkbox (German: Anonymisieren), Entity API examples, and a schema review checklist.epilot auth login --anonymizeand theData: anonymizedstatus line.data_classificationto the common properties, plus a short section.The facts come from
@epilot/anonymization, the entity-api (anonymization/*), svc-audit-log-api, epilot-mcp and epilot360-entity-builder-v2.Companion UI changes, which all link to this page:
anonymizeon the approval request details--anonymizecopyTest plan
docusaurus buildsucceeds with no broken links or anchors🤖 Generated with Claude Code
https://claude.ai/code/session_01W6dmanYSntb6SZZmQ3QfJK
Generated by Claude Code