Skip to content

Document health_checks and auto_reauth connection flags#374

Draft
aylee855 wants to merge 1 commit into
mainfrom
hypeship/auth-config-flags
Draft

Document health_checks and auto_reauth connection flags#374
aylee855 wants to merge 1 commit into
mainfrom
hypeship/auth-config-flags

Conversation

@aylee855
Copy link
Copy Markdown
Contributor

Summary

Adds documentation for the two new managed-auth connection flags shipped on the API:

  • health_checks (boolean, default true) — whether periodic health checks run at all.
  • auto_reauth (boolean, default true) — whether a failing scheduled health check is allowed to attempt re-authentication.

Updates /auth/configuration:

  • Expands "Credentials and Auto-Reauth" to introduce both flags, the interaction between them (auto_reauth is only meaningful while health_checks is true), and a create-time example with both disabled.
  • Notes that auto_reauth: true is opt-in only — connections still transition to NEEDS_AUTH when reauth preconditions (e.g. saved credentials) aren't met.
  • Adds both fields to the "Updating a Connection" table and notes the changes take effect immediately on the running connection.

Test plan

  • Preview renders cleanly on Mintlify
  • Code samples copy/paste correctly in both TypeScript and Python

Document the new health_checks and auto_reauth boolean flags on managed
auth connections. Both default to true. Explains the interaction (auto_reauth
is gated by health_checks running) and notes that auto_reauth is opt-in only
— it doesn't guarantee reauth feasibility.

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

mintlify Bot commented May 22, 2026

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

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview May 22, 2026, 12:24 AM

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

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