Add Per-User Sessions guide - #566
Closed
robertjamesprior wants to merge 1 commit into
Closed
robertjamesprior wants to merge 1 commit into
robertjamesprior wants to merge 1 commit into
Conversation
Assembles the bring-your-own-credentials path for running one authenticated browser per end user: profiles, the one-writer rule, pools with reuse: false, standby economics, and per-user tagging. Profiles currently sit under the Auth group, so customers who aren't using Managed Auth have a reason to skip the page that explains the primitive they most need. This page sits alongside that group and routes to the existing sections without the Managed Auth assumption. Also documents that readOnly on a live view URL is a display option rather than a security boundary, which was not stated anywhere. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Author
|
Closing — this is moving into the customer-facing best practices guide rather than the public docs. The live view docs gap stands on its own and is tracked as KERNEL-2219. |
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
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
Adds
browsers/per-user-sessions— a guide for running one authenticated browser per end user when the customer's own application owns the credentials, rather than using Managed Auth.The content it covers already exists and is good; what's missing is a path through it for developers who aren't using Managed Auth.
auth/profilessits inside the Auth group in the sidebar, and both it and the pools guide route the per-user pattern through Managed Auth — the profiles page frames per-user mapping as "attach all their accounts as auth connections," and the pools page says to use Managed Auth to populate profile state. A customer who has been told they don't need Managed Auth has a reason to skip the page explaining the primitive they most need.This page sits alongside the Auth group at the same level and links out to the existing sections instead of restating them.
What it covers
Prevent concurrent profile writessection, with the reminder that the check and the create are separate requestsreuse: falsetimeout_secondsdefaults to 60 and that GPU browsers don't support standbytagsNew content worth a closer look
The Share a live view with your user section is the only part not already documented somewhere.
browsers/live-viewcurrently describesreadOnlyas "the view will be non-interactive" with nothing about it being a display option rather than a security control, and nothing about the URL granting control of the browser or remaining valid until the browser is deleted. For this audience the natural design is to pop a live view so the end user can enter their own password, so the caveat matters.It's written as guidance ("treat the URL as a credential", "serve it from your own backend") rather than describing how the limitation is reached. Happy to soften or drop it if it's better handled alongside the scoped-live-view-token work.
Verification
packages/api/openapi.yaml:tags(object, max 50 pairs),timeout_seconds(integer, default 60, max 259200),profile.save_changesTagstype confirmed askernel.Tags(type Tags map[string]string) against the Go SDK, andTimeoutSeconds: kernel.Int(...)matches existing usage inbrowsers/terminationandbrowsers/poolsdeleteByID/delete_by_id/DeleteByIDmatch the idiom inauth/profilesmintlify dev. Worth a preview check on the two cross-page anchors (/auth/profiles#prevent-concurrent-profile-writesand/browsers/pools#per-user-profiles-with-browser-pools) before merge. I avoided linking the numbered heading onauth/profilesbecause the one existing link to it inchangelog.mdxretains a comma in the slug and I couldn't confirm which form resolves.🤖 Generated with Claude Code