Bug 1202436 - Document authentication method precedence - #2722
Merged
dklawren merged 1 commit intoAug 25, 2026
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Documents BMO REST API authentication precedence and prevents client confusion when multiple credential types are supplied.
Changes:
- Clarifies that username/password credentials take precedence over API keys without fallback.
- Explains interaction with API-key-only accounts and recommends sending only the API key.
Show a summary per file
| File | Description |
|---|---|
docs/en/rst/api/core/v1/general.rst |
Documents authentication precedence and remediation guidance. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Balanced
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
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.
Bug 1202436 tracks missing REST API documentation for requests that provide more than one authentication method. BMO evaluates legacy username/password credentials before API keys, so a valid API key can be ignored. When the account requires API-key authentication, the mixed request fails with an
API key authentication is requirederror.This documents the precedence, lack of fallback, and interaction with the
Require API key authentication for API requestspreference. It advises clients to send only theX-BUGZILLA-API-KEYheader rather than disabling the preference. Authentication behavior is unchanged.Bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1202436
Testing: