From 015d219cdd21453e57bf6a246e0938be97aaac2d Mon Sep 17 00:00:00 2001
From: Pierre <pierre.guillot@sonarsource.com>
Date: Tue, 4 Apr 2023 17:34:42 +0200
Subject: [PATCH] SONAR-18956 improve api/system/health permission requirement
 description

---
 .../org/sonar/server/platform/ws/HealthActionSupport.java   | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/platform/ws/HealthActionSupport.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/platform/ws/HealthActionSupport.java
index aa2c68cd721..cbb8881e021 100644
--- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/platform/ws/HealthActionSupport.java
+++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/platform/ws/HealthActionSupport.java
@@ -22,6 +22,7 @@ package org.sonar.server.platform.ws;
 import com.google.common.io.Resources;
 import java.util.Comparator;
 import org.sonar.api.server.ws.WebService;
+import org.sonar.process.ProcessProperties;
 import org.sonar.process.cluster.health.NodeDetails;
 import org.sonar.process.cluster.health.NodeHealth;
 import org.sonar.server.health.ClusterHealth;
@@ -52,7 +53,10 @@ public class HealthActionSupport {
         " <li>YELLOW: SonarQube is usable, but it needs attention in order to be fully operational</li>" +
         " <li>RED: SonarQube is not operational</li>" +
         " </ul>" +
-        "</p>")
+        "</p><br>" +
+        "Requires the 'Administer System' permission or " +
+        "system passcode (see " + ProcessProperties.Property.WEB_SYSTEM_PASS_CODE + " in sonar.properties).<br>" +
+        "When SonarQube is in safe mode (waiting or running a database upgrade), only the authentication with a system passcode is supported.")
       .setSince("6.6")
       .setResponseExample(Resources.getResource(this.getClass(), "example-health.json"))
       .setHandler(handler);
-- 
2.39.5