Skip to content

Strengthen guidance on sensitive data and PII for search attributes and workflow IDs#4301

Merged
lennessyy merged 6 commits intomainfrom
docs/search-attribute-pii-warning
Mar 17, 2026
Merged

Strengthen guidance on sensitive data and PII for search attributes and workflow IDs#4301
lennessyy merged 6 commits intomainfrom
docs/search-attribute-pii-warning

Conversation

@dustin-temporal
Copy link
Contributor

@dustin-temporal dustin-temporal commented Mar 17, 2026

Summary

  • Elevates the existing :::note about unencrypted Search Attributes to a :::caution admonition with a clear title
  • Expands guidance to explicitly cover both attribute names and values (previously only values were mentioned in the main warning)
  • Adds reasoning: Search Attributes bypass the Payload Codec, so encryption is not possible without breaking search functionality
  • Adds compliance context: using sensitive data as attribute names increases exposure risk and may violate GDPR, HIPAA, or SOC 2
  • adds similar guidance to workflow IDs

Why

The existing docs had a brief, easy-to-miss note that Search Attribute values are unencrypted. The guidance about not using PII in attribute names was buried in a bullet list under Default Search Attributes. Users working with sensitive data (healthcare, finance) need prominent, actionable guidance with compliance reasoning to make the case internally for proper data handling.

Test plan

  • Verify the :::caution admonition renders correctly
  • Verify the [warning above](#search-attribute) anchor link resolves correctly
  • Verify the [Payload Codec](/dataconversion#payload-codec) link resolves correctly
  • Check no broken links with yarn check-links

🤖 Generated with Claude Code

┆Attachments: EDU-6059 Strengthen Search Attribute guidance on sensitive data and PII

Elevate the existing note about unencrypted Search Attributes to a
caution admonition with expanded guidance covering both attribute names
and values. Add reasoning about compliance risk (GDPR, HIPAA, SOC 2)
and recommend using opaque identifiers instead. Cross-reference the
warning from the Default Search Attributes section.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@dustin-temporal dustin-temporal requested a review from a team as a code owner March 17, 2026 19:21
@vercel
Copy link

vercel bot commented Mar 17, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
temporal-documentation Ready Ready Preview, Comment Mar 17, 2026 10:06pm

Request Review

@github-actions
Copy link
Contributor

github-actions bot commented Mar 17, 2026

📖 Docs PR preview links

Workflow Ids and other user-defined identifiers (Workflow Type, Task Queue,
Activity, Signal/Query/Update names) are stored in plain text and bypass the
Payload Codec. Add a caution admonition warning against using PII directly
as a Workflow Id, with compliance reasoning (GDPR, HIPAA, SOC 2).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@dustin-temporal dustin-temporal changed the title Strengthen Search Attribute guidance on sensitive data and PII Strengthen guidance on sensitive data and PII for search attributes and workflow IDs Mar 17, 2026
@lennessyy lennessyy enabled auto-merge (squash) March 17, 2026 22:04
@lennessyy lennessyy merged commit 16e6d5c into main Mar 17, 2026
10 checks passed
@lennessyy lennessyy deleted the docs/search-attribute-pii-warning branch March 17, 2026 22:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants