Skip to content

auth: refresh managed auth docs for May 2026 changes#359

Merged
masnwilliams merged 6 commits into
mainfrom
hypeship/managed-auth-docs-may
May 12, 2026
Merged

auth: refresh managed auth docs for May 2026 changes#359
masnwilliams merged 6 commits into
mainfrom
hypeship/managed-auth-docs-may

Conversation

@masnwilliams
Copy link
Copy Markdown
Contributor

@masnwilliams masnwilliams commented May 12, 2026

Summary

Refreshes the managed auth docs to reflect everything that's shipped since the docs were last touched in early April. Goal: docs match current behavior.

New

  • auth/react.mdx — full integration guide for @onkernel/managed-auth-react: install, Next.js example, same-origin proxying, appearance API (variables / elements / layout / theme), localization, props, and headless step exports. Added to the Auth → Integration Types nav alongside Hosted UI and Programmatic. Overview page now shows a 3-card chooser.

Updated

  • auth/programmatic.mdx
    • MFA type enum updated to current SDK shape: sms, email, totp, push, call, password, switch (was: sms, email, totp, push, call, security_key). password and switch are new; security_key was never in the SDK enum.
    • Added a callout for switch (generic "Use another method" / "Try another way" links).
    • AWAITING_EXTERNAL_ACTION section now shows that mfa_options / pending_sso_buttons / sign_in_options can be populated alongside the external action message — submit one to switch verification methods, or keep polling. Added a code example for the push + "Try another way" fallback.
  • auth/profiles.mdx, browsers/extensions.mdx, reference/cli/extensions.mdx — name uniqueness scope corrected from org to project (matches DB constraint change).

Test plan

  • Mintlify preview renders the new auth/react page and the 3-card chooser on auth/overview
  • No broken internal links
  • Code samples in auth/programmatic.mdx match current SDK shape (verified MfaOption.type against kernel-node-sdk types)

Note

Low Risk
Low risk: documentation-only changes (new guide, nav updates, and behavior clarifications) with no runtime code modifications.

Overview
Adds a new auth/react guide documenting the @onkernel/managed-auth-react embedded login flow (installation, backend handoff, same-origin proxying, styling/localization, and headless exports) and surfaces it in navigation; auth/overview is updated to present Hosted UI/React/Programmatic as three integration options.

Updates Managed Auth docs to match current behavior: documents record_session replay recording on connections/logins (auth/hosted-ui, auth/faq, auth/programmatic), refreshes programmatic MFA option types (including password and switch) and clarifies fallback options during AWAITING_EXTERNAL_ACTION, and corrects multiple places to state that profile/extension names are unique per project (not org).

Reviewed by Cursor Bugbot for commit ef1580c. Bugbot is set up for automated code reviews on this repo. Configure here.

…allbacks

- Add new auth/react.mdx for @onkernel/managed-auth-react drop-in component
- Add React Component card to auth overview integration types
- Document `switch` MFA option type for generic method-switcher links
- Document fallback mfa_options/sso_buttons/sign_in_options on AWAITING_EXTERNAL_ACTION
- Update MFA type enum to current SDK shape (drop security_key, add password/switch)
- Update profile/extension name uniqueness from org-scoped to project-scoped

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 12, 2026

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

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview May 12, 2026, 9:09 PM

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

masnwilliams and others added 3 commits May 12, 2026 21:10
Adds docs for the new record_session flag — connection-wide default or
per-login override that captures a browser replay of every managed auth
login session. Surfaces it as a debugging tool in the FAQ and lists it
in the connection update field tables.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
The .login() response returns id and handoff_code as separate fields —
integrators using the React component pass those directly to the
frontend. hosted_url points at Kernel's hosted page and is only
relevant for the Hosted UI flow.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
cursor[bot]
cursor Bot approved these changes May 12, 2026
@masnwilliams masnwilliams marked this pull request as ready for review May 12, 2026 22:33
masnwilliams and others added 2 commits May 12, 2026 18:33
Connection-default record_session applies to every browser session tied
to the connection — initial logins, periodic health checks, and
automatic re-authentications. Per-login override only records that one
login attempt.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@firetiger-agent
Copy link
Copy Markdown

Firetiger deploy monitoring skipped

This PR didn't match the auto-monitor filter configured on your GitHub connection:

Any PR that changes the kernel API. Monitor changes to API endpoints (packages/api/cmd/api/) and Temporal workflows (packages/api/lib/temporal) in the kernel repo

Reason: PR only updates documentation files (*.mdx); it does not change any API endpoints in packages/api/cmd/api/ or Temporal workflows in packages/api/lib/temporal.

To monitor this PR anyway, reply with @firetiger monitor this.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

Re-evaluated the current diff after the synchronize event. The changes are limited to MDX documentation pages and one docs.json navigation entry for the new React auth page. I didn't find any production codepaths, infrastructure, schema, auth/permission enforcement logic, or model prompt files modified, and there is no CODEOWNERS file in the repo.

git diff --check passed. The PR is already approved at the current head commit, so I did not submit another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

I re-evaluated the current head diff (0f356960e0e9be32645eed84c8d3f8ea023d8426). The PR only changes MDX documentation pages and adds one docs.json navigation entry for the new auth React component page. There are no production codepaths, infrastructure files, schema changes, auth/permission logic, or prompt/instruction files modified. The changes since the prior approval are limited to small wording clarifications about record_session behavior in auth docs, so the risk has not increased.

The PR is already approved, so I’m not posting another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

I based this on the actual diff: the PR only changes documentation pages (auth/*.mdx, browser/CLI docs), adds a new auth/react.mdx documentation page, and adds one docs.json navigation entry. I didn't find production codepaths, infrastructure, schema changes, auth/permission enforcement logic, or model prompt files modified. I also didn't find a CODEOWNERS file requiring code owner review.

git diff --check passed. GitHub already reports the PR as approved, so I did not submit another approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale comment

Risk assessment: Very Low.

I assessed the current diff directly. The changes are limited to Mintlify documentation content (auth/*.mdx, browser/CLI docs), a new auth/react.mdx guide, and a single docs.json navigation entry. I didn't find production codepaths, infrastructure files, schema changes, auth or permission enforcement logic, or model prompt/instruction files modified.

git diff --check passed. I also didn't find a CODEOWNERS file in the repo. GitHub already reports this PR as approved, so I did not submit another approval; the latest changes do not increase the risk level.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low.

I assessed the current diff directly. The changes are limited to Mintlify documentation content (auth/*.mdx, browser/CLI docs), a new auth/react.mdx guide, and a single docs.json navigation entry. I didn't find production codepaths, infrastructure files, schema changes, auth or permission enforcement logic, or model prompt/instruction files modified.

git diff --check passed. I also didn't find a CODEOWNERS file or pending review requests. The PR already has an approval, so I did not submit another approval; the synchronized changes do not increase the risk level.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@masnwilliams masnwilliams merged commit 6a346c1 into main May 12, 2026
4 checks passed
@masnwilliams masnwilliams deleted the hypeship/managed-auth-docs-may branch May 12, 2026 22:55
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