docs: ValidMind Library OIDC device-flow authentication [sc-17043] - #1458
Merged
Conversation
Add a dedicated OIDC setup guide and point install, credentials, troubleshooting, and quickstarts at the alternate path shipped in library 2.13+. Co-authored-by: Cursor <cursoragent@cursor.com>
11 tasks
Confirm and document that the Public API accepts OIDC bearer tokens alongside API keys, and point the interactive OpenAPI page at the overview auth guidance. Co-authored-by: Cursor <cursoragent@cursor.com>
Quarto emitted fenced-div warnings during CI validate when an OIDC credentials tabset was nested inside the existing setup tabset. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
nibalizer
approved these changes
Jul 31, 2026
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.
What and why?
Documents OAuth 2.0 / OIDC device authorization flow authentication for the ValidMind Library (shipped under sc-15741; covered in 26.06 release notes).
Before: Developer docs only covered API key / secret
vm.init().After:
.env, troubleshooting, monitoring, and get-started snippet steps point to the OIDC pathShortcut: https://app.shortcut.com/validmind/story/17043
Implementation evidence:
validmind/validmind-libraryPR #501 (vm.init(issuer=..., client_id=...), token cache)validmind/backendBearer OIDC for tracking + org connectivity / snippet settingsvalidmind/frontendGetting Started OIDC connectivity snippet when org allowsdevice_flow/anyHow to test
Hosted preview:
.envfilesWhat needs special review?
validmind-libraryand synced viamake notebooks/make get-source. This PR only links the existing OIDC quickstart already present insite/notebooks/. A follow-up PR should lightly update primary API-key notebooks (quickstarts + set-up tutorials) with a one-line OIDC alternative pointer, then sync into documentation.requires_client_auth/ backend#3139). Overview docs now cover API key + OIDC bearer (Authorization: Bearer, optionalX-Organization-Id). The interactive OpenAPI page (vm-api) still surfaces API-key auth from swagger only, with a callout linking to the overview.Dependencies, breaking changes, and deployment notes
Release notes
Documented how to authenticate the ValidMind Library with OAuth 2.0 / OIDC device flow as an alternative to API keys. Learn more ...
Checklist