]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-16567 Add more details about the SonarQube-Authentication-Token-Expiration...
authorWouter Admiraal <wouter.admiraal@sonarsource.com>
Thu, 21 Jul 2022 08:23:42 +0000 (10:23 +0200)
committersonartech <sonartech@sonarsource.com>
Thu, 21 Jul 2022 20:03:06 +0000 (20:03 +0000)
server/sonar-docs/src/pages/setup/operate-server.md
server/sonar-docs/src/pages/user-guide/user-token.md

index d336946dd7ce3f4bd4837c8ffe06e59f2a306e52..7ac9ba1a2c69d7de2590252d8dd30608a9350e28 100644 (file)
@@ -200,7 +200,10 @@ server {
 ```
 
 ### Forward SonarQube custom headers
-SonarQube adds custom HTTP headers in order for some features to function properly. The reverse proxy should be configured to forward the following header: `SonarQube-Authentication-Token-Expiration`.
+SonarQube adds custom HTTP headers. The reverse proxy should be configured to forward the following headers:
+
+* `SonarQube-Authentication-Token-Expiration`  
+This header is added to a web service response when using [tokens](/user-guide/user-token/) to authenticate. Forwarding this header is not required for the SonarQube features to work properly.
 
 ## Secure your Network
 
index 7fffe07895b8c698f2c4d2736877aff782225868..8274973a5f26673d94ccbe7a3e07ae3a37ad018e 100644 (file)
@@ -56,3 +56,7 @@ User tokens must replace your normal login process in the following scenarios:
 * when invoking web services: just pass the token instead of your login while doing the basic authentication.
 
 In both cases, you don't need to provide a password (so when running analyses on your code, the property `sonar.password` is optional). Using a token is the preferred method over using a login and password.
+
+### Expiration date in HTTP response
+
+When using a token to interact with web services, a `SonarQube-Authentication-Token-Expiration` HTTP header will be added to the response. This header contains the token expiration date and can help third-party tools track upcoming expirations, so the token can be rotated in time.