Skip to main content
← Back to list
01Issue
FeatureShippedSwamp Club
Assigneesstack72

Relationships

#1267 Docs: document collective token CLI usage in API key authentication pages

Opened by stack72 · 7/18/2026· Shipped 7/20/2026

Context

PR swamp-club/swamp#1900 (swamp-club#1264) added CLI support for collective API tokens. The CLI now handles collective token whoami responses, displays collective identity and scopes, and surfaces scope-specific 403 errors.

Two manual documentation pages need updates to cover this new functionality.

What to update

1. content/manual/reference/api-key-authentication.md

Add the collective token whoami output shape. The page already documents the swamp_org_ prefix and credential storage, but doesn't show what swamp auth whoami outputs when authenticated with a collective token:

  • Log mode: Collective token: <slug> on <serverUrl> + Scopes: <scope1>, <scope2> + Collectives: <slug>
  • JSON mode: { authenticated: true, collectiveToken: true, collectiveSlug: "...", scopes: [...], collectives: [...] }

2. content/manual/how-to/authenticate-with-api-keys.md

Add a section for using collective tokens with the CLI. Currently only shows personal key flows. Should cover:

  • Setting SWAMP_API_KEY with a collective token (swamp_org_ prefix)
  • Running swamp auth whoami to verify the token
  • Using swamp extension push with a collective token
  • What happens when a token lacks a required scope (the new scope-aware error message)
02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED+ 1 MOREASSIGNED+ 3 MOREFINDINGS+ 3 MOREPR_MERGED+ 1 MORENOTIFICATION_SKIPPED

Shipped

7/20/2026, 9:03:35 PM

Click a lifecycle step above to view its details.

03Sludge Pulse
stack72 assigned stack727/20/2026, 8:37:10 PM

Sign in to post a ripple.