aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntoine Vigneau <antoine.vigneau@sonarsource.com>2024-06-05 18:39:50 +0200
committersonartech <sonartech@sonarsource.com>2024-06-06 20:02:43 +0000
commit0486e84fb3d8f8b9bda7558758934bf6221c1753 (patch)
tree9247fff21e2266d15d2f0228a6f4442f633777e3
parentcb21b78646b109648a0033c937c0aa3d7c14b157 (diff)
downloadsonarqube-0486e84fb3d8f8b9bda7558758934bf6221c1753.tar.gz
sonarqube-0486e84fb3d8f8b9bda7558758934bf6221c1753.zip
NOJIRA Clarify api/v2 externalProvider description
-rw-r--r--server/sonar-webserver-webapi-v2/src/main/java/org/sonar/server/v2/api/user/request/UserUpdateRestRequest.java10
1 files changed, 5 insertions, 5 deletions
diff --git a/server/sonar-webserver-webapi-v2/src/main/java/org/sonar/server/v2/api/user/request/UserUpdateRestRequest.java b/server/sonar-webserver-webapi-v2/src/main/java/org/sonar/server/v2/api/user/request/UserUpdateRestRequest.java
index decc01eb601..86df618f040 100644
--- a/server/sonar-webserver-webapi-v2/src/main/java/org/sonar/server/v2/api/user/request/UserUpdateRestRequest.java
+++ b/server/sonar-webserver-webapi-v2/src/main/java/org/sonar/server/v2/api/user/request/UserUpdateRestRequest.java
@@ -76,11 +76,11 @@ public class UserUpdateRestRequest {
this.scmAccounts = UpdateField.withValue(scmAccounts);
}
- @Schema(implementation = String.class, description = "New external provider. Only authentication system installed are available. " +
- "Use 'LDAP' identity provider for single server LDAP setup. " +
- "Use 'LDAP_{serverKey}' identity provider for multiple LDAP servers setup. " +
- "Warning: when this information has been updated for a user, the user will only be able to authenticate via the new identity provider. " +
- "It is not possible to migrate external user to local one.")
+ @Schema(implementation = String.class, description = """
+ New identity provider. Only providers configured in your platform are supported. This could be: github, gitlab, bitbucket, saml, LDAP, LDAP_{serverKey}
+ (according to your server configuration file).
+ Warning: when this is updated, the user will only be able to authenticate using the new identity provider. Also, it is not possible to remove the identity provider of a user.
+ """)
public UpdateField<String> getExternalProvider() {
return externalProvider;
}