Skip to content

docs: ValidMind Library OIDC device-flow authentication [sc-17043] - #1458

Merged
emmavdh merged 3 commits into
mainfrom
emma/sc-17043-documentation-library-oidc
Jul 31, 2026
Merged

docs: ValidMind Library OIDC device-flow authentication [sc-17043]#1458
emmavdh merged 3 commits into
mainfrom
emma/sc-17043-documentation-library-oidc

Conversation

@emmavdh

@emmavdh emmavdh commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

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:

  • New guide: Authenticate with OIDC device flow
  • Install, .env, troubleshooting, monitoring, and get-started snippet steps point to the OIDC path
  • Existing OIDC quickstart notebook is linked from the developer sidebar and Library landing page
  • Public REST API overview documents OIDC bearer auth alongside API keys; OpenAPI explorer notes the gap vs swagger

Shortcut: https://app.shortcut.com/validmind/story/17043

Implementation evidence:

  • validmind/validmind-library PR #501 (vm.init(issuer=..., client_id=...), token cache)
  • validmind/backend Bearer OIDC for tracking + org connectivity / snippet settings
  • validmind/frontend Getting Started OIDC connectivity snippet when org allows device_flow / any

How to test

skills/validmind-docs-coverage/scripts/render-pages.sh \
  developer/quickstart/authenticate-with-oidc-device-flow.qmd \
  developer/quickstart/install-and-initialize-validmind-library.qmd \
  developer/quickstart/store-credentials-in-env-file.qmd \
  support/troubleshooting.qmd \
  developer/validmind-library.qmd \
  guide/monitoring/enable-monitoring.qmd \
  get-started/developer/quickstart-developer.qmd \
  get-started/validator/quickstart-validator.qmd \
  reference/validmind-rest-api-vm.qmd \
  reference/vm-api.qmd

Hosted preview:

What needs special review?

  • Notebooks intentionally out of scope for this PR. Notebooks are authored in validmind-library and synced via make notebooks / make get-source. This PR only links the existing OIDC quickstart already present in site/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.
  • Admin / IdP setup is summarized at a high level (customer needs admin-enabled connectivity). Deep IdP registration guidance remains with platform/security teams.
  • Public REST API OAuth: Confirmed shipped (requires_client_auth / backend #3139). Overview docs now cover API key + OIDC bearer (Authorization: Bearer, optional X-Organization-Id). The interactive OpenAPI page (vm-api) still surfaces API-key auth from swagger only, with a callout linking to the overview.
  • R library still documents API keys only (no OIDC support found).

Dependencies, breaking changes, and deployment notes

  • Docs-only; customers need Library >= 2.13 and org OIDC connectivity enabled for the new path to work end-to-end.
  • No product/code dependencies in this repository.

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

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

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>
@emmavdh emmavdh added the documentation Improvements or additions to documentation label Jul 30, 2026
emmavdh and others added 2 commits July 30, 2026 19:34
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>
@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@emmavdh emmavdh self-assigned this Jul 31, 2026
@emmavdh
emmavdh added this pull request to the merge queue Jul 31, 2026
Merged via the queue into main with commit 947e209 Jul 31, 2026
5 of 6 checks passed
@emmavdh
emmavdh deleted the emma/sc-17043-documentation-library-oidc branch July 31, 2026 01:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants