Skip to content

docs: say which Pro token controls hide when API tokens are off - #16565

Merged
blakeaowens merged 1 commit into
devfrom
docs/api-token-controls
Oct 27, 2026
Merged

blakeaowens merged 1 commit into
devfrom
docs/api-token-controls

Conversation

@blakeaowens

Copy link
Copy Markdown
Contributor

Description

Docs for a DefectDojo Pro change to the API token controls.

  • automation/api/api-v2-docs.md: the Pro API v2 Token page reads the key again when its tab comes back into view, and shows an API Key Changed notice when the key was replaced in another tab or by an administrator. The sentence saying the page shows the reason when tokens are disabled is replaced by what Pro now does: with DD_API_TOKENS_ENABLED=False it hides API v2 Token in the account menu (an old link shows Not Found), Force Token Reset, the bulk Reset API Tokens action and the API Access walkthrough, and the MCP Service page says an AI provider cannot connect. With only DD_API_TOKEN_AUTH_ENDPOINT_ENABLED=False, the token page leaves out the instructions for that endpoint.
  • admin/user_management/PRO__resetting_user_credentials.md: Reset API Tokens and Force Token Reset are offered only while API tokens are enabled.
  • navigation/PRO__sidebar.md: the account menu lists API v2 Token when API tokens are enabled.
  • metrics_reports/ai/mcp_server_pro.md: the MCP Server prerequisites note that an instance with API tokens disabled cannot be reached through it.

English pages only; the language copies are translated automatically.

Test results

Docs only. Each statement was checked against the Pro change in a browser, with API tokens on, with a restart under DD_API_TOKENS_ENABLED=False, and with the api-token-auth endpoint off.

Documentation

This PR is the documentation change.

The API v2 Token page re-reads the key when its tab comes back into view.
With DD_API_TOKENS_ENABLED=False, Pro hides API v2 Token, Force Token Reset,
bulk Reset API Tokens and the MCP token prompt; with only
DD_API_TOKEN_AUTH_ENDPOINT_ENABLED=False the token page leaves out the
api-token-auth instructions.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@blakeaowens
blakeaowens requested a review from Maffooch as a code owner October 27, 2026 04:45
@blakeaowens blakeaowens added this to the 3.5.0 milestone Oct 27, 2026
@github-actions github-actions Bot added the docs label Oct 27, 2026
@blakeaowens
blakeaowens added this pull request to the merge queue Oct 27, 2026
Merged via the queue into dev with commit c38f24b Oct 27, 2026
31 checks passed
@blakeaowens
blakeaowens deleted the docs/api-token-controls branch October 27, 2026 08:46
@defectdojo-release-tracker defectdojo-release-tracker Bot modified the milestones: 3.5.0, 3.4.302 Oct 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants