Skip to content

docs : expand owner-scoping guidance in API authentication docs #1103

Description

@tmdeveloper007

Summary of What Needs to be Done:
The API authentication docs (docs/api-authentication.md) describe how to authenticate with the API key but do not explain how multi-workspace isolation works via the X-User-Id header.

Changes that Need to be Made:
Add an "Owner Scoping and Multi-Workspace Isolation" section to docs/api-authentication.md covering:

  • The X-User-Id header and how it drives owner_id on tasks/findings/reports
  • The difference between the shared deployment API key (authentication) and the per-user owner identity (authorization)
  • How resolve_owner_id() maps X-User-Id to user: format
  • The DEFAULT_OWNER_ID fallback for single-user deployments
  • Example: passing X-User-Id: alice to isolate Alices workspace data
  • Security note: upstream auth proxy is responsible for validating X-User-Id before forwarding

Impact that it would Provide:

Note: This task is being handled by tmdeveloper007 — please assign to that account when picking it up.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions