Skip to content

docs : expanded owner-scoping guidance in API authentication docs#1108

Merged
utksh1 merged 1 commit into
utksh1:mainfrom
tmdeveloper007:#1103
Jun 20, 2026
Merged

docs : expanded owner-scoping guidance in API authentication docs#1108
utksh1 merged 1 commit into
utksh1:mainfrom
tmdeveloper007:#1103

Conversation

@tmdeveloper007

Copy link
Copy Markdown
Contributor

Closes #1103.

Summary of What Has Been Done:
Added an "Owner Scoping and Multi-Workspace Isolation" section to docs/api-authentication.md explaining how the X-User-Id header drives workspace isolation and how it relates to the shared deployment API key.

Changes Made:

  • Added a two-layer identity model overview (authentication vs. authorization)
  • Added resolution logic table showing how X-User-Id maps to owner_id
  • Added concrete curl examples showing Alice and Bob workspaces using the same API key
  • Added a security note emphasizing that X-User-Id must be set by a trusted upstream auth proxy
  • Added a comparison table between API Key and X-User-Id headers

Impact it Made:

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

@utksh1 utksh1 added level:beginner 20 pts difficulty label for small beginner-friendly PRs type:docs Documentation work category bonus label area:docs Documentation or contributor guide work area:security Security-sensitive implementation or tests labels Jun 20, 2026

@utksh1 utksh1 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Focused change with green checks; approving.

@utksh1 utksh1 merged commit c28506a into utksh1:main Jun 20, 2026
17 checks passed
@utksh1 utksh1 added the gssoc:approved Admin validation: approved for GSSoC scoring label Jun 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs Documentation or contributor guide work area:security Security-sensitive implementation or tests gssoc:approved Admin validation: approved for GSSoC scoring level:beginner 20 pts difficulty label for small beginner-friendly PRs type:docs Documentation work category bonus label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs : expand owner-scoping guidance in API authentication docs

2 participants