Update security instructions for API-M web portals#11249
Update security instructions for API-M web portals#11249Rami2212 wants to merge 1 commit intowso2:masterfrom
Conversation
Removed detailed instructions for restricting access to the management console and added a note about controlling access to all web applications.
|
|
📝 WalkthroughDocumentation Update: Web Portal Access ControlThis PR updates the "Securing Web Portals" documentation by removing references to an unsupported configuration option for restricting Management Console access. Changes Made
What Remains UnchangedThe documentation continues to cover the two supported methods for controlling web application access:
Affected file: Lines changed: +1/-18 WalkthroughThe pull request updates the security documentation for API and web portals by removing references to the standalone management console access-control configuration ( 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Removes outdated documentation from the “Securing Web portals” page that described restricting access to the Management Console via an unsupported [admin_console.control_access] configuration.
Changes:
- Removed the
[admin_console.control_access]deployment.tomlexample and its explanatory note from “Restricting access to web portals”. - Adjusted the introduction to the “Restricting access to web portals” section (but it still contains a misleading reference that needs follow-up).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <p>When you enable access control for the management console, only the IP addresses specified in the <code>allow</code> parameter will have access. All other IP addresses will be blocked. Make sure to include all IP addresses that require access to the management console in the whitelist.</p> | ||
| </div> | ||
| </html> | ||
| You can restrict access to the management console of the API-M runtime by binding the management console with selected IP addresses. Note that you can restrict access to all web portals as explained below. |
There was a problem hiding this comment.
This introductory sentence still says access can be restricted to the management console by binding it to selected IPs, but the management-console-only mechanism ([admin_console.control_access]) was removed in this PR. As written, it’s misleading because the only remaining options shown are global web-app access control and per-servlet filtering. Reword this sentence to describe the supported mechanisms (restrict all web apps or specific servlet URLs), without implying a management-console-only binding option.
| You can restrict access to the management console of the API-M runtime by binding the management console with selected IP addresses. Note that you can restrict access to all web portals as explained below. | |
| You can restrict access to the web portals of the API-M runtime either by allowing only selected IP addresses to access all web applications or by applying access control filters to specific servlet URLs, as explained below. |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/docs/install-and-setup/setup/security/securing-api-m-web-portals.md`:
- Line 35: Reword the sentence that currently reads "You can restrict access to
the management console of the API-M runtime by binding the management console
with selected IP addresses." so it no longer implies a standalone
management-console-only IP-binding option; instead explicitly state that access
is controlled via the general web-portal IP-binding/configuration methods
described below (refer to the phrase "restrict access to all web portals" and
the subsequent configuration sections), e.g., replace the sentence with a clear
pointer that management console access is restricted using the same IP-binding
and portal configuration methods documented in the following sections.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e3014ae5-d86d-4aa6-91b5-8e78f798b18f
📒 Files selected for processing (1)
en/docs/install-and-setup/setup/security/securing-api-m-web-portals.md
| <p>When you enable access control for the management console, only the IP addresses specified in the <code>allow</code> parameter will have access. All other IP addresses will be blocked. Make sure to include all IP addresses that require access to the management console in the whitelist.</p> | ||
| </div> | ||
| </html> | ||
| You can restrict access to the management console of the API-M runtime by binding the management console with selected IP addresses. Note that you can restrict access to all web portals as explained below. |
There was a problem hiding this comment.
Clarify Line 35 to avoid implying an unsupported console-only setting.
Line 35 still reads like there is a direct management-console IP-binding option. To align with the documented supported methods, rephrase to explicitly point to the configurations below.
Proposed wording update
-You can restrict access to the management console of the API-M runtime by binding the management console with selected IP addresses. Note that you can restrict access to all web portals as explained below.
+You can restrict access to API-M web portals, including management console endpoints, using the supported access-control configurations described below.As per coding guidelines: "Provide concise, actionable feedback focused on correctness and best practices."
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| You can restrict access to the management console of the API-M runtime by binding the management console with selected IP addresses. Note that you can restrict access to all web portals as explained below. | |
| You can restrict access to API-M web portals, including management console endpoints, using the supported access-control configurations described below. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/docs/install-and-setup/setup/security/securing-api-m-web-portals.md` at
line 35, Reword the sentence that currently reads "You can restrict access to
the management console of the API-M runtime by binding the management console
with selected IP addresses." so it no longer implies a standalone
management-console-only IP-binding option; instead explicitly state that access
is controlled via the general web-portal IP-binding/configuration methods
described below (refer to the phrase "restrict access to all web portals" and
the subsequent configuration sections), e.g., replace the sentence with a clear
pointer that management console access is restricted using the same IP-binding
and portal configuration methods documented in the following sections.
Remove unsupported Management Console access control configuration
Summary
Removed the documentation for restricting access to the Management Console via
[admin_console.control_access]configuration, as this feature is no longer supported at the product level.Problem
The following configuration was documented under the Restricting access to web portals section of the Securing Web Portals page:
This configuration is no longer functional at the product level, making the documentation misleading and potentially causing confusion for users who attempt to use it.
Changes
[admin_console.control_access]indeployment.toml.Affected Pages
Type of Change
Additional Notes
The remaining access restriction options — controlling access to all web applications via
[web_app.control_access]and restricting access to specific servlets via[[servlet_access_control_filter]]— are unaffected and remain documented as before.