Skip to content

Update managed auth docs for CUA support, PATCH endpoint, and auto-allowed SSO domains#304

Open
masnwilliams wants to merge 3 commits intomainfrom
hypeship/update-managed-auth-docs
Open

Update managed auth docs for CUA support, PATCH endpoint, and auto-allowed SSO domains#304
masnwilliams wants to merge 3 commits intomainfrom
hypeship/update-managed-auth-docs

Conversation

@masnwilliams
Copy link
Contributor

@masnwilliams masnwilliams commented Mar 24, 2026

Summary

Updates managed auth documentation to reflect recent merged PRs in kernel/kernel:

New features documented

  • PATCH /auth/connections/{id} — New endpoint to update connection config (login_url, credential, allowed_domains, health_check_interval, save_credentials, proxy). Added "Updating a Connection" section to hosted-ui.mdx.
  • Sign-in options — Account/org pickers during login (sign_in_options field, sign_in_option_id submit parameter). Added new section to programmatic.mdx.
  • sso_provider submit parameter — CUA-preferred alternative to sso_button_selector for SSO. Added new section to programmatic.mdx.

Corrections

  • Auto-allowed SSO domains — Updated all SSO examples to reflect that common provider domains (Google, Microsoft, Okta, Auth0, GitHub, etc.) are now automatically allowed. Removed incorrect instructions to manually add accounts.google.com to allowed_domains.
  • Health check intervals — Fixed Start-Up plan interval from "15 min" to "20 min" to match API spec.

New FAQ entries

  • Trial org access — Managed auth and profiles are available during trials (PR #1476).

PRs reflected

  • #1306 — CUA support, PATCH endpoint, sign_in_options, sso_provider
  • #1476 — Trial org access
  • #1553, #1517, #1358 — Internal changes, no doc impact

Files changed

  • auth/overview.mdx — Updated SSO bullet point
  • auth/hosted-ui.mdx — Auto-allowed SSO domains, new "Updating a Connection" section
  • auth/programmatic.mdx — SSO provider (CUA), sign-in options, updated step reference
  • auth/credentials.mdx — Auto-allowed SSO domains in SSO/OAuth example
  • auth/faq.mdx — Fixed health check intervals, added trial access FAQ

Note

Low Risk
Low risk since changes are documentation-only, but incorrect guidance could impact integrators if any API behavior described here is outdated.

Overview
Documents new Managed Auth capabilities: updating connections via PATCH /auth/connections/{id}/auth.connections.update, and expanded programmatic flow handling for SSO provider submission (sso_provider) and account/org pickers (sign_in_options/sign_in_option_id).

Updates SSO guidance across credentials, hosted-ui, overview, and programmatic to reflect that common OAuth provider domains are auto-allowed (with allowed_domains reserved for custom providers), and refreshes the FAQ with corrected health-check minimums plus additional entries (trial availability, forcing re-auth via .login(), error codes including unsupported_auth_method).

Written by Cursor Bugbot for commit 576bab1. This will update automatically on new commits. Configure here.

…lowed SSO domains

- Document new PATCH /auth/connections/{id} endpoint for updating connections
- Add sign_in_options and sign_in_option_id for account/org pickers
- Add sso_provider as CUA-preferred alternative to sso_button_selector
- Update SSO docs to reflect auto-allowed provider domains
- Fix health check intervals (Start-Up is 20 min, not 15 min)
- Add FAQ entry for trial org access to managed auth
@mintlify
Copy link
Contributor

mintlify bot commented Mar 24, 2026

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

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview Mar 24, 2026, 2:27 AM

@masnwilliams masnwilliams marked this pull request as ready for review March 24, 2026 02:31
…ements

- Document sign_in_options field with id/label/description and distinguishing note from MFA
- Document sso_provider as singular string state field with distinguishing note from SSO buttons
- Add Updating Connections section with PATCH fields table and SDK examples
- Add sign-in options FAQ linking to programmatic docs
- Clarify health check intervals as plan minimums (users can set higher)
- Add common error codes (credentials_invalid, bot_detected, captcha_blocked) to failure FAQ

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link

@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.

Evidence from the diff:

  • Changed files are limited to documentation pages under auth/*.mdx.
  • No application/runtime code, build config, dependency, infra, auth enforcement logic, or permission checks were modified.
  • Edits are content updates and examples (SSO domain guidance, PATCH/update docs, sign-in option docs, FAQ clarifications).

Blast radius:

  • User-facing documentation accuracy only.
  • Potential impact is guidance correctness, not production behavior.

Based on the current diff, this PR is safe to approve under the Very Low risk criteria.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

- Add scope positioning in overview.mdx: Managed Auth automates login flows
- Add tips after complete example in programmatic.mdx: SSO/MFA/account picker
  pointer and hosted_url fallback
- Add passkey error code (unsupported_auth_method) to warning in faq.mdx
- Add force re-auth FAQ with .login() code snippet
- Add scope FAQ: what types of flows Managed Auth supports

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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