Repository navigation
docs(audit): bring the remaining auth docs in line with the #928 superadmin model - #930
Merged
Merged
Conversation
The superadmin redefinition (#928, PR #929) updated the web UI requirements doc, but three other places still described the old single-capability model: - campus/audit/web/data.py: the data endpoints are not gated by "the browser OAuth session" any more — they are gated by the trace-view capability, and an authenticated session without it gets 403, not just 401 for the unauthenticated case. - campus/audit/web/ui.py: the page map still said "login required" and did not mention the API-key sign-in path. - docs/audit-tracing.md: the runbook covered minting keys but never said that browser access is a separate grant, so an operator following it to give someone access to the trace viewer had no way to learn about AUDIT_ADMINS or the two capabilities. It now has a "Browser access" section with the capability table, the two ways to grant a person access, and the bearer-credential caveat. - docs/DEPLOY.md: points at that section, so a producer key is not mistaken for browser access.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #929 (the
AUDIT_ADMINSsuperadmin redefinition, merged as a8465ed).The redefinition updated
campus/audit/docs/web-ui-requirements.md(§2.1, §5.2, §5.3) and thecampus/audit/web/auth.pydocstring, but three other places still described the old single-capability model:campus/audit/web/data.pycampus/audit/web/ui.pydocs/audit-tracing.mddocs/DEPLOY.mdWhat the runbook gains
A new Browser access (who can open the trace viewer) section: the capability table (
can_view_traces()/can_manage_keys()× Campus account / API key), the two ways to grant a person access (a superadmin account onAUDIT_ADMINS, or atraces:readkey handed over), and the bearer-credential caveat — whoever holds an audit key can read every trace in the deployment, so mint one per person with the narrowest scope that does the job and an expiry.Verification
Unit suite passing,
ruff check .clean,pyrightclean (0 errors). Docstring and Markdown only — no behaviour change.