DOC-192 Edits for MMF-2871 (#6849)

diff --git a/server/sonar-docs/src/images/okta/saml-okta-sq-saml.png b/server/sonar-docs/src/images/okta/saml-okta-sq-saml.png
new file mode 100644 (file)
index 0000000..1866ac6
Binary files /dev/null and b/server/sonar-docs/src/images/okta/saml-okta-sq-saml.png differ

diff --git a/server/sonar-docs/src/images/saml-keycloak-sq-saml.png b/server/sonar-docs/src/images/saml-keycloak-sq-saml.png
new file mode 100644 (file)
index 0000000..1866ac6
Binary files /dev/null and b/server/sonar-docs/src/images/saml-keycloak-sq-saml.png differ

diff --git a/server/sonar-docs/src/pages/instance-administration/authentication/saml/azuread.md b/server/sonar-docs/src/pages/instance-administration/authentication/saml/azuread.md
index 9f9cab97cbe9853fcf46d186a121294273469e95..f04600b671674e3b07e5152d47c5e4495e314b64 100644 (file)
--- a/server/sonar-docs/src/pages/instance-administration/authentication/saml/azuread.md
+++ b/server/sonar-docs/src/pages/instance-administration/authentication/saml/azuread.md
@@ -82,3 +82,5 @@ For either case, the corresponding group name should exist in SonarQube under **
 1. In the login form, the new button **Log in with SAML** (or a custom name specified in the `sonar.auth.saml.providerName` setting) allows users to connect with their SAML account.
   
   ![SAML Azure AD SonarQube Login](/images/azure/saml-azure-sq-login.png)
+
+Before enabling the SAML authentication on SonarQube, you can verify that the configuration is correct by clicking on the “Test Configuration” button. A SAML login will be initiated and useful information about the SAML response obtained from the Identity provider will be returned. 
\ No newline at end of file

diff --git a/server/sonar-docs/src/pages/instance-administration/authentication/saml/keycloak.md b/server/sonar-docs/src/pages/instance-administration/authentication/saml/keycloak.md
index 4a2070962e364f8f87b2a816447d970370e21e6a..b0fdb3f0711b471e238823e7a5ef8a0c0b433a22 100644 (file)
--- a/server/sonar-docs/src/pages/instance-administration/authentication/saml/keycloak.md
+++ b/server/sonar-docs/src/pages/instance-administration/authentication/saml/keycloak.md
@@ -56,7 +56,6 @@ Configure the new SAML client
 ## SonarQube configuration
 Configure the SAML authentication: **[Administration > Configuration > General Settings > Authentication > SAML](/#sonarqube-admin#/admin/settings?category=authentication)**
 
-* **Enabled**: *true*
 * **Application ID**: The value of the "Client ID" you set in Keycloak (for example "sonarqube")
 * **Provider ID**: The value of the `EntityDescriptor > entityID` attribute in the XML configuration file (e.g., "http://keycloak:8080/auth/realms/sonarqube")
 * **SAML login url**: The value of `SingleSignOnService > Location` attribute in the XML configuration file (e.g., "http://keycloak:8080/auth/realms/sonarqube/protocol/saml")
@@ -72,3 +71,9 @@ Configure the SAML authentication: **[Administration > Configuration > General S
 You can find [here](https://manpages.ubuntu.com/manpages/focal/man1/pkcs8.1ssl.html) some instructions to convert different key formats.
 
 In the login form, the new button "Log in with SAML" allows users to connect with their SAML account.
+
+## Enabling and testing SAML authentication
+1. In the SonarQube SAML settings, enable SAML.
+  ![SAML OKTA SonarQube SAML](/images/saml-keycloak-sq-saml.png)
+
+Before enabling the SAML authentication on SonarQube, you can verify that the configuration is correct by clicking on the “Test Configuration” button. A SAML login will be initiated and useful information about the SAML response obtained from the Identity provider will be returned.                                                                                                                                                                                                                                                                                                                              
\ No newline at end of file

diff --git a/server/sonar-docs/src/pages/instance-administration/authentication/saml/okta.md b/server/sonar-docs/src/pages/instance-administration/authentication/saml/okta.md
index 58497ecc7f0b62a2c2a772dca850e2cc79dff887..3e5c7e05471965efba86ea49eb5afcb3243de721 100644 (file)
--- a/server/sonar-docs/src/pages/instance-administration/authentication/saml/okta.md
+++ b/server/sonar-docs/src/pages/instance-administration/authentication/saml/okta.md
@@ -109,8 +109,6 @@ To integrate Okta (Identity Provider) with SonarQube (Service Provider), both si
 
 Go to **[Administration > Configuration > General Settings > Authentication > SAML](/#sonarqube-admin#/admin/settings?category=authentication)**
 
-- **Enabled**: *true*.
-
 - **Application ID**: The value of the *Audience URI (SP Entity ID)* you set in Okta (for example, `sonarqube`).
 
 - **Provider ID**: The value of *Identity Provider Issuer* provided in **View SAML setup instructions** from Okta.
@@ -136,3 +134,9 @@ Go to **[Administration > Configuration > General Settings > Authentication > SA
 The service provider private key and certificate can be either a new self-signed pair or any existing pair available in your infrastructure.
 
 In the login form, the new button **Log in with SAML** (or a custom name specified in the `sonar.auth.saml.providerName` setting) allows users to connect with their SAML account.
+
+## Enabling and testing SAML authentication
+1. In the SonarQube SAML settings, enable SAML.
+  ![SAML OKTA SonarQube SAML](/images/okta/saml-okta-sq-saml.png)
+
+Before enabling the SAML authentication on SonarQube, you can verify that the configuration is correct by clicking on the “Test Configuration” button. A SAML login will be initiated and useful information about the SAML response obtained from the Identity provider will be returned.