diff options
| author | tv <tv@krebsco.de> | 2026-11-09 17:35:12 +0000 |
|---|---|---|
| committer | tv <tv@krebsco.de> | 2026-11-09 19:10:26 +0100 |
| commit | 5f7e29cec4333715346b4bf3195633db93449d9d (patch) | |
| tree | 3574cb120e01c4272452666aeb518ac0d24e8e90 /docs | |
| parent | 3bf93bc192bf362b58b2161ac05da0bb8323bf43 (diff) | |
auth: whoami says what the request may do
`GET /auth/whoami` lists the user's capabilities (`caps`) and its token's `limit`, if
any, side by side; what the request may do is what both give, as endpoints decide it.
It says so now (`may`): the capabilities, or with a limit each capability met with each
of the limit's (`Capability::meet`): at the deeper of the two paths, a `*` of one
taking the other's key there, with the rights both name; nothing where the paths part,
no right is shared, or the path is protocol data one of them doesn't name.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/access.md | 6 | ||||
| -rw-r--r-- | docs/openapi.yaml | 2 |
2 files changed, 5 insertions, 3 deletions
diff --git a/docs/access.md b/docs/access.md index 1397656..571034e 100644 --- a/docs/access.md +++ b/docs/access.md @@ -177,8 +177,10 @@ forgets it. The login page token pasted, from a login by key, say; the dashboard renews it while open ([`dashboard.md`](dashboard.md)). -`GET /auth/whoami` says the swarm, who a request's user is, how it proved it, and what -it may do. +`GET /auth/whoami` says the swarm, who a request's user is, how it proved it, its +capabilities (`caps`), and what this request may do (`may`): those, or with a token +that says less (`limit`), what both give, each capability's path the deeper of the two +and its rights those both name. Pages of other origins, the dashboards of other members, may call a node with a token: its own links (`/admin/dashboard/links/own`, and its events) and messages diff --git a/docs/openapi.yaml b/docs/openapi.yaml index adee4a6..1b4a199 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -1031,7 +1031,7 @@ paths: get: tags: [Auth] summary: Who you are here - description: The swarm, the user, how it proved it (`htpasswd`, `header`, `token`), its registry entry's capabilities, and its token's claims if it came with one. + description: The swarm, the user, how it proved it (`htpasswd`, `header`, `token`), its registry entry's capabilities (`caps`), what this request may do (`may`, a list of capabilities; with a token that says less, what both give), and its token's claims if it came with one. responses: '200': description: Who. |