SONAR-17233 improve SAML configuration fields descriptions

diff --git a/server/sonar-auth-saml/src/main/java/org/sonar/auth/saml/SamlSettings.java b/server/sonar-auth-saml/src/main/java/org/sonar/auth/saml/SamlSettings.java
index 4954076f41ebf275730354f0b8dab94de30168e1..edca87b14f66ff57ee566f3916b7574ec9442a71 100644 (file)
--- a/server/sonar-auth-saml/src/main/java/org/sonar/auth/saml/SamlSettings.java
+++ b/server/sonar-auth-saml/src/main/java/org/sonar/auth/saml/SamlSettings.java
@@ -130,7 +130,7 @@ public class SamlSettings {
         .build(),
       PropertyDefinition.builder(APPLICATION_ID)
         .name("Application ID")
-        .description("Identifier of the application.")
+        .description("The identifier used on the Identity Provider for registering SonarQube.")
         .defaultValue("sonarqube")
         .category(CATEGORY)
         .subCategory(SUBCATEGORY)
@@ -138,7 +138,7 @@ public class SamlSettings {
         .build(),
       PropertyDefinition.builder(PROVIDER_NAME)
         .name("Provider Name")
-        .description("Name displayed for the provider in the login page.")
+        .description("Name of the Identity Provider displayed in the login page when SAML authentication is active.")
         .defaultValue("SAML")
         .category(CATEGORY)
         .subCategory(SUBCATEGORY)
@@ -146,21 +146,21 @@ public class SamlSettings {
         .build(),
       PropertyDefinition.builder(PROVIDER_ID)
         .name("Provider ID")
-        .description("Identifier of the identity provider, the entity that provides SAML authentication.")
+        .description("Identifier of the Identity Provider, the entity that provides SAML authentication.")
         .category(CATEGORY)
         .subCategory(SUBCATEGORY)
         .index(4)
         .build(),
       PropertyDefinition.builder(LOGIN_URL)
         .name("SAML login url")
-        .description("SAML login URL for the identity provider.")
+        .description("The URL where the Identity Provider expects to receive SAML requests.")
         .category(CATEGORY)
         .subCategory(SUBCATEGORY)
         .index(5)
         .build(),
       PropertyDefinition.builder(CERTIFICATE)
         .name("Identity provider certificate")
-        .description("X.509 certificate for the identity provider.")
+        .description("The public X.509 certificate used by the Identity Provider to authenticate SAML messages.")
         .category(CATEGORY)
         .subCategory(SUBCATEGORY)
         .type(PASSWORD)
@@ -168,21 +168,21 @@ public class SamlSettings {
         .build(),
       PropertyDefinition.builder(USER_LOGIN_ATTRIBUTE)
         .name("SAML user login attribute")
-        .description("Attribute defining the user login in SAML.")
+        .description("The name of the attribute where the SAML Identity Provider will put the login of the authenticated user.")
         .category(CATEGORY)
         .subCategory(SUBCATEGORY)
         .index(7)
         .build(),
       PropertyDefinition.builder(USER_NAME_ATTRIBUTE)
         .name("SAML user name attribute")
-        .description("Attribute defining the user name in SAML.")
+        .description("The name of the attribute where the SAML Identity Provider will put the name of the authenticated user.")
         .category(CATEGORY)
         .subCategory(SUBCATEGORY)
         .index(8)
         .build(),
       PropertyDefinition.builder(USER_EMAIL_ATTRIBUTE)
         .name("SAML user email attribute")
-        .description("Attribute defining the user email in SAML.")
+        .description("The name of the attribute where the SAML Identity Provider will put the email of the authenticated user.")
         .category(CATEGORY)
         .subCategory(SUBCATEGORY)
         .index(9)