Skip to content

Update anonymous sessions docs to match EA architecture guide - #1870

Open
BcnCarlos wants to merge 1 commit into
mainfrom
Update-anonymous-sessons-EA
Open

Update anonymous sessions docs to match EA architecture guide#1870
BcnCarlos wants to merge 1 commit into
mainfrom
Update-anonymous-sessons-EA

Conversation

@BcnCarlos

Copy link
Copy Markdown
Contributor

Summary

Reconciles main/docs/manage-users/sessions/anonymous-sessions/* against the Auth0 Anonymous Sessions Architecture & Implementation Guide and the Management API OAS artifact. Found and fixed several gaps:

  • anonymous-sessions.mdx
    • Documented the cross-domain transfer-ticket mechanism (anon_transfer_token via urn:auth0:anon_transfer_token audience) for cases where cookies get blocked (Apple ITP, cross-domain CORS).
    • Documented the ROPG transfer scenario (anonymous_session_token in the /oauth/token body).
    • Added the missing caveat that Auth0 does not offer server-side session invalidation.
    • Removed an unverified Auth0-Anonymous-Session header example — it does not appear in the architecture guide or the Management API OAS, and could not be confirmed as a real mechanism.
  • configure-anonymous-sessions.mdx
    • Added Dashboard instructions alongside the existing Management API steps, for tenant, application, API, and client-grant configuration.
    • Fixed the resource-server PATCH example: it included allow_anonymous_access, a field that does not exist in the Management API schema (UpdateResourceServerRequestContent has additionalProperties: false and no such field).
    • Added the missing activate_cookie parameter to the tenant-settings example.
    • Corrected the example lifetime value (was 1440 minutes / 1 day, which undercut our own "30 days or longer" best-practice guidance).
  • configure-custom-claims-for-anonymous-sessions.mdx (new)
    • Documents Claims Mapping — mapping anonymous_session.metadata.* fields directly into access token custom claims, since anonymous sessions have no post-login Action execution to call setCustomClaim().
    • Registered in manage-users.json navigation.

Verification

  • Cross-checked activate_cookie, allow_anonymous_access (absent), and token_lifetime_for_anonymous_access_tokens against main/docs/oas/management/v2/management-api-oas.json schemas (TenantSettingsSessionsAnonymous, UpdateResourceServerRequestContent).
  • Verified all new/updated internal cross-links resolve to real headings (fixed two links that would have pointed at bold text instead of markdown headings).

Known pre-existing issue (not fixed here, out of scope)

anonymous-sessions.mdx has a "Batch and minimize metadata updates" link pointing to configure-anonymous-sessions#update-the-session-with-metadata, an anchor that doesn't exist in the target file. Flagging for a follow-up.

Test plan

  • Review rendered Mintlify preview for the four changed/new pages
  • Confirm mermaid diagrams render correctly (transfer-ticket sequence diagram)
  • Confirm the new page appears in navigation under Anonymous Sessions
  • Link checker passes with no new broken fragments

🤖 Generated with Claude Code

Fixes several gaps found comparing our anonymous sessions docs against
the Anonymous Sessions Architecture & Implementation Guide and the
Management API OAS artifact:

- anonymous-sessions.mdx: document the transfer-ticket mechanism for
  cross-domain session transfer (anon_transfer_token), the ROPG
  transfer scenario, and the lack of server-side session invalidation.
  Removed an unverified Auth0-Anonymous-Session header example not
  present in the OAS or the architecture guide.
- configure-anonymous-sessions.mdx: add Dashboard instructions
  alongside the existing Management API steps for tenant, application,
  API, and client-grant configuration. Fixed the resource-server PATCH
  example, which included allow_anonymous_access — a field that does
  not exist in the Management API schema (additionalProperties: false
  on UpdateResourceServerRequestContent). Added the missing
  activate_cookie parameter and corrected the example lifetime value
  to match our own 30-day-or-longer best practice guidance.
- configure-custom-claims-for-anonymous-sessions.mdx (new): documents
  Claims Mapping, which lets an API map anonymous_session.metadata
  fields directly into access token custom claims, since anonymous
  sessions have no post-login Action execution to call
  setCustomClaim(). Registered in manage-users.json navigation.
@BcnCarlos
BcnCarlos requested a review from a team as a code owner September 12, 2026 13:30
@mintlify

mintlify Bot commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
auth0 🟢 Ready View Preview Sep 12, 2026, 1:38 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@mintlify

mintlify Bot commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
auth0-docs-dev 🟢 Ready View Preview Sep 12, 2026, 1:38 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@mintlify

mintlify Bot commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
auth0-docs-staging 🟢 Ready View Preview Sep 12, 2026, 1:37 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@github-actions

Copy link
Copy Markdown
Contributor

Summary

Status Count
🔍 Total 47
🔗 Unique 31
✅ Successful 38
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 1
❓ Unknown 0
🚫 Errors 8
⛔ Unsupported 0

Errors per input

Errors in main/docs/manage-users/sessions/anonymous-sessions.mdx

  • [ERROR] </docs/customize/actions/explore-triggers/password-reset-triggers#password-reset-triggers> (at 197:3) | File not found. Check if file exists and path is correct
  • [ERROR] </docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger> (at 121:209) | File not found. Check if file exists and path is correct
  • [ERROR] </docs/customize/actions/explore-triggers/signup-and-login-triggers/pre-user-registration-trigger> (at 121:81) | File not found. Check if file exists and path is correct
  • [ERROR] </docs/manage-users/sessions/anonymous-sessions/configure-anonymous-sessions#update-the-session-with-metadata> (at 192:22) | Cannot find fragment

Errors in main/docs/manage-users/sessions/anonymous-sessions/anonymous-sessions-use-cases.mdx

  • [ERROR] </docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger> (at 100:15) | File not found. Check if file exists and path is correct
  • [ERROR] </docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger> (at 131:15) | File not found. Check if file exists and path is correct
  • [ERROR] </docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger> (at 68:15) | File not found. Check if file exists and path is correct
  • [ERROR] </docs/customize/actions/explore-triggers/signup-and-login-triggers/pre-user-registration-trigger> (at 36:15) | File not found. Check if file exists and path is correct

Full Github Actions output

Run on commit 9a28b02.

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.

1 participant