Skip to content

Docs/expand OIDC integration guide#38

Merged
basauth merged 2 commits into
mainfrom
docs/expand-oidc-integration-guide
Jun 9, 2026
Merged

Docs/expand OIDC integration guide#38
basauth merged 2 commits into
mainfrom
docs/expand-oidc-integration-guide

Conversation

@basauth

@basauth basauth commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Added content to the OIDC Integration Guide


Checklist

Step 1 — Identify affected surfaces

Check every surface this PR touches:

  • Authentication or token verification logic (src/basis_gateway/auth/)
  • Identity normalization or subject mapping (src/basis_gateway/auth/subject_mapper.py)
  • Audit event emission or gateway event vocabulary (src/basis_gateway/audit/)
  • Readiness component registration or behavior (src/basis_gateway/readiness.py)
  • API request/response schemas (src/basis_gateway/api/schemas.py)
  • Environment variable configuration (src/basis_gateway/config.py)
  • Correlation ID handling (src/basis_gateway/middleware/)
  • Public documentation (README.md, docs/)
  • None of the above — this PR does not touch any of these surfaces

Step 2 — Classify the change

  • Additive only (new behavior, new config option, new audit event — existing callers unaffected)
  • Breaking (changes API contract, removes config support, alters audit event shape, changes authentication behavior)
  • Not applicable (docs, tests, refactor only)

If the change affects authentication or audit behavior

  • New or changed behavior is covered by tests
  • Audit event emission for affected paths verified (all pre-evaluation failure paths must emit a gateway event)
  • Security model assumptions in SECURITY.md and docs/release-readiness.md still hold

If the change modifies basis-core integration

  • Change uses only the stable public API (basis-core/docs/public-api.md)
  • No direct imports from basis_core internals

Tests

Describe what tests cover this change, or explain why no new tests are needed.

  • pytest passes locally
  • ruff check passes
  • ruff format --check passes
  • mypy src passes

Add 14 sections covering purpose/scope, architectural flow, gateway vs
kernel responsibilities, full configuration reference, provider
compatibility, example provider snippets (Keycloak, Auth0, Entra ID,
explicit JWKS override), JWT validation behavior, identity normalization
(claim mapping from subject_mapper.py), startup/readiness (correct
/health and /ready endpoint paths), local development, troubleshooting
table, OT considerations, and security notes.

Correct endpoint paths: old doc referenced /health/live and /health/ready;
actual routes are /health (liveness) and /ready (readiness).

See Also links updated to relative paths consistent with README; sibling
repo links (basis-architecture, basis-core) marked as such.
@basauth basauth merged commit e245b11 into main Jun 9, 2026
3 checks passed
@basauth basauth deleted the docs/expand-oidc-integration-guide branch June 9, 2026 15:27
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.

2 participants