Add resident KM requirement note to Basic Authentication docs#10976
Open
Add resident KM requirement note to Basic Authentication docs#10976
Conversation
|
|
Co-authored-by: AnuGayan <19290404+AnuGayan@users.noreply.github.com> Agent-Logs-Url: https://github.com/wso2/docs-apim/sessions/bab872e6-5e1f-454d-87e3-8200e00e0b8b
Copilot
AI
changed the title
[WIP] Add note to Basic Auth section about resident KM support
Add resident KM requirement note to Basic Authentication docs
Mar 23, 2026
AnuGayan
approved these changes
Mar 23, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Documents a previously undocumented limitation in WSO2 API Manager: Basic Authentication only works with the resident Key Manager, and third-party Key Manager setups require OAuth2-based authentication.
Changes:
- Added a
!!! noteadmonition to the Basic Authentication documentation clarifying the resident Key Manager requirement. - Explicitly states that Basic Authentication will not work when a third-party Key Manager is configured, and OAuth2 must be used instead.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
en/docs/api-security/runtime/api-authentication/secure-apis-using-basic-authentication.md
Outdated
Show resolved
Hide resolved
…ing-basic-authentication.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Basic Authentication in WSO2 API Manager only works with the resident Key Manager. When a third-party KM is configured, only OAuth2 is supported — but this limitation was never documented explicitly.
Purpose
Documents the undocumented limitation that Basic Auth is incompatible with third-party Key Manager configurations. Resolves the gap identified for v4.6.0.
Goals
Add a visible note to the Basic Auth documentation page so users are immediately aware that Basic Auth requires the WSO2 resident Key Manager and that OAuth2 must be used when a third-party KM is in place.
Approach
Added a
!!! noteadmonition near the top ofen/docs/api-security/runtime/api-authentication/secure-apis-using-basic-authentication.md, placed right after the intro paragraph and before any configuration steps:!!! note Basic Authentication is only supported when using the **WSO2 resident Key Manager**. If a third-party Key Manager is configured, Basic Authentication will not function and only OAuth2-based authentication is supported for API invocations in that scenario.User stories
Release note
Added a note to the Basic Authentication documentation clarifying that Basic Auth is only supported with the WSO2 resident Key Manager. Third-party KM configurations must use OAuth2 for API authentication.
Documentation
en/docs/api-security/runtime/api-authentication/secure-apis-using-basic-authentication.md— this PR is the documentation change.Training
N/A
Certification
N/A — no behavioral change; documentation clarification only.
Marketing
N/A
Automation tests
Security checks
Samples
N/A
Related PRs
N/A
Migrations (if applicable)
N/A
Test environment
N/A — documentation change only
Learning
N/A
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.