aboutsummaryrefslogtreecommitdiffstats
path: root/server
diff options
context:
space:
mode:
authorcynthiabethea <108268296+cynthiabethea@users.noreply.github.com>2022-10-13 11:11:18 +0100
committersonartech <sonartech@sonarsource.com>2022-10-13 20:03:18 +0000
commit5fd36bf48fd09e0afdbb638a0ec140586f91bf31 (patch)
tree4d019f0730cab75abcb43d683654755dd1eb0368 /server
parent4b0a6624cf22a91c22f7c73f7a8fd6ec49a9d206 (diff)
downloadsonarqube-5fd36bf48fd09e0afdbb638a0ec140586f91bf31.tar.gz
sonarqube-5fd36bf48fd09e0afdbb638a0ec140586f91bf31.zip
DOC-192 Edits for MMF-2871 (#6849)
Diffstat (limited to 'server')
-rw-r--r--server/sonar-docs/src/images/okta/saml-okta-sq-saml.pngbin0 -> 11974 bytes
-rw-r--r--server/sonar-docs/src/images/saml-keycloak-sq-saml.pngbin0 -> 11974 bytes
-rw-r--r--server/sonar-docs/src/pages/instance-administration/authentication/saml/azuread.md2
-rw-r--r--server/sonar-docs/src/pages/instance-administration/authentication/saml/keycloak.md7
-rw-r--r--server/sonar-docs/src/pages/instance-administration/authentication/saml/okta.md8
5 files changed, 14 insertions, 3 deletions
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
index 00000000000..1866ac66ce1
--- /dev/null
+++ b/server/sonar-docs/src/images/okta/saml-okta-sq-saml.png
Binary files 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
index 00000000000..1866ac66ce1
--- /dev/null
+++ b/server/sonar-docs/src/images/saml-keycloak-sq-saml.png
Binary files 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 9f9cab97cbe..f04600b6716 100644
--- 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 4a2070962e3..b0fdb3f0711 100644
--- 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 58497ecc7f0..3e5c7e05471 100644
--- 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.