Skip to main content

API Reference

API Surfaces

This page summarizes repo-owned API and HTTP surfaces.

For machine-readable feature/test posture, use MODULE_FEATURES.md (docs/MODULE_FEATURES.md).

Plane OIDC Bridge​

Purpose:

  • bridge browser auth handoff into OIDC flow
  • expose bridge status and logout surfaces

Primary routes:

  • /auth/oidc/login/
  • /auth/oidc/callback/
  • /auth/oidc/logout/
  • /auth/oidc/backchannel-logout/
  • /api/v1/auth/oidc/status
  • /healthz

Reference:

  • PLANE_OIDC_BOOTSTRAP.md (docs/PLANE_OIDC_BOOTSTRAP.md)

Loom OIDC Bridge​

Purpose:

  • route Loom auth entry and callback handling through OIDC
  • expose bridge health/status surfaces

Primary routes:

  • /auth/oidc/login/
  • /auth/oidc/callback/
  • /auth/oidc/logout/
  • /auth/oidc/backchannel-logout/
  • /api/v1/auth/oidc/status
  • /healthz

Reference:

  • LOOM_OIDC_BOOTSTRAP.md (docs/LOOM_OIDC_BOOTSTRAP.md)

Lantern OIDC Bridge​

Purpose:

  • expose canonical Lantern OIDC auth entry/callback/logout surfaces
  • expose lane readback/status for fail-closed runtime verification

Primary routes:

  • /auth/oidc/login/
  • /auth/oidc/callback/
  • /auth/oidc/logout/
  • /auth/oidc/backchannel-logout/
  • /api/v1/auth/oidc/status
  • /api/v1/identity/universal-work/human-queue-self-readback
  • /healthz

Reference:

  • LANTERN_OIDC_BOOTSTRAP.md (docs/LANTERN_OIDC_BOOTSTRAP.md)

Agent Reconcile API​

Purpose:

  • read and preview reconcile state
  • expose worker execution status and run summaries

Primary routes:

  • /api/v1/identity/agent-reconcile/status
  • /api/v1/identity/agent-reconcile/runs
  • /api/v1/identity/agent-reconcile/drift
  • /api/v1/identity/agent-reconcile/config
  • /api/v1/identity/agent-reconcile/preview
  • /api/v1/identity/rocketchat-jadda-owner-resolution
  • /api/v1/identity/agent-reconcile/worker/status
  • /api/v1/identity/agent-reconcile/worker/runs
  • /api/v1/identity/agent-reconcile/worker/run
  • /healthz
  • /metrics

Reference:

  • AGENT_RECONCILE_AND_GC.md (docs/AGENT_RECONCILE_AND_GC.md)
  • ROCKETCHAT_JADDA_OWNER_RESOLUTION_READBACK.md (docs/ROCKETCHAT_JADDA_OWNER_RESOLUTION_READBACK.md)

Notes​

  • Detailed contract semantics belong to the contract pages under docs/ and config/**.
  • Runtime owner boundaries and fail-closed behavior are documented in OPERATIONS.md and FABRIC_CONSUMER_SURFACES.md (docs/FABRIC_CONSUMER_SURFACES.md).
  • The Jadda owner-resolution route may resolve principal_id, tenant_ref, and business_context_ref only from Keycloak-admin readback plus repo-owned admitted context-map truth. It returns an allow decision only after a bounded, protected Fabric entitlement readback; missing or denied Fabric truth fails closed.

License: AGPLv3 Project: https://helpifyr.com