Skip to content

The Unified and Autonomous Development Platform

feat: Able to configure SSO provider via restful api (OD-2645)

Robin Shene143cf51b35a
diff --git a/server-core/src/main/java/io/onedev/server/rest/resource/SsoProviderResource.java b/server-core/src/main/java/io/onedev/server/rest/resource/SsoProviderResource.java
new file mode 100644
index 0000000000..c087db6829
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/rest/resource/SsoProviderResource.java
@@ -0,0 +1,123 @@
+package io.onedev.server.rest.resource;
+
+import java.util.List;
+
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import javax.validation.Valid;
+import javax.validation.constraints.NotNull;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.DELETE;
+import javax.ws.rs.GET;
+import javax.ws.rs.NotAcceptableException;
+import javax.ws.rs.NotFoundException;
+import javax.ws.rs.POST;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+
+import org.apache.shiro.authz.UnauthorizedException;
+
+import io.onedev.server.data.migration.VersionedXmlDoc;
+import io.onedev.server.model.SsoProvider;
+import io.onedev.server.rest.annotation.Api;
+import io.onedev.server.security.SecurityUtils;
+import io.onedev.server.service.AuditService;
+import io.onedev.server.service.SsoProviderService;
+
+@Path("/sso-providers")
+@Consumes(MediaType.APPLICATION_JSON)
+@Produces(MediaType.APPLICATION_JSON)
+@Singleton
+public class SsoProviderResource {
+
+ @Inject
+ private SsoProviderService ssoProviderService;
+
+ @Inject
+ private AuditService auditService;
+
+ @Api(order=100)
+ @GET
+ @Path("/{ssoProviderId}")
+ public SsoProvider getSsoProvider(@PathParam("ssoProviderId") Long ssoProviderId) {
+ if (!SecurityUtils.isAdministrator())
+ throw new UnauthorizedException();
+ return ssoProviderService.load(ssoProviderId);
+ }
+
+ @Api(order=200)
+ @GET
+ public List<SsoProvider> listSsoProviders() {
+ if (!SecurityUtils.isAdministrator())
+ throw new UnauthorizedException();
+ return ssoProviderService.query();
+ }
+
+ @Api(order=250, description="Get SSO provider id by name")
+ @Path("/ids/{name}")
+ @GET
+ public Long getSsoProviderId(@PathParam("name") String name) {
+ if (!SecurityUtils.isAdministrator())
+ throw new UnauthorizedException();
+
+ var ssoProvider = ssoProviderService.find(name);
+ if (ssoProvider != null)
+ return ssoProvider.getId();
+ else
+ throw new NotFoundException();
+ }
+
+ @Api(order=300, description="Create SSO provider")
+ @POST
+ public Long createSsoProvider(@NotNull @Valid SsoProvider ssoProvider) {
+ if (!SecurityUtils.isAdministrator())
+ throw new UnauthorizedException();
+
+ if (ssoProviderService.find(ssoProvider.getName()) != null)
+ throw new NotAcceptableException("Name is already used by another SSO provider");
+
+ ssoProviderService.createOrUpdate(ssoProvider);
+ var auditContent = VersionedXmlDoc.fromBean(ssoProvider).toXML();
+ auditService.audit(null, "created SSO provider \"" + ssoProvider.getName() + "\" via RESTful API", null, auditContent);
+
+ return ssoProvider.getId();
+ }
+
+ @Api(order=350, description="Update SSO provider of specified id")
+ @Path("/{ssoProviderId}")
+ @POST
+ public Response updateSsoProvider(@PathParam("ssoProviderId") Long ssoProviderId, @NotNull @Valid SsoProvider ssoProvider) {
+ if (!SecurityUtils.isAdministrator())
+ throw new UnauthorizedException();
+
+ SsoProvider existingSsoProvider = ssoProviderService.find(ssoProvider.getName());
+ if (existingSsoProvider != null && !existingSsoProvider.equals(ssoProvider))
+ throw new NotAcceptableException("Name is already used by another SSO provider");
+
+ var oldAuditContent = ssoProvider.getOldVersion().toXML();
+ var newAuditContent = VersionedXmlDoc.fromBean(ssoProvider).toXML();
+
+ ssoProviderService.createOrUpdate(ssoProvider);
+
+ auditService.audit(null, "changed SSO provider \"" + ssoProvider.getName() + "\" via RESTful API", oldAuditContent, newAuditContent);
+
+ return Response.ok().build();
+ }
+
+ @Api(order=400)
+ @Path("/{ssoProviderId}")
+ @DELETE
+ public Response deleteSsoProvider(@PathParam("ssoProviderId") Long ssoProviderId) {
+ if (!SecurityUtils.isAdministrator())
+ throw new UnauthorizedException();
+ var ssoProvider = ssoProviderService.load(ssoProviderId);
+ var oldAuditContent = VersionedXmlDoc.fromBean(ssoProvider).toXML();
+ ssoProviderService.delete(ssoProvider);
+ auditService.audit(null, "deleted SSO provider \"" + ssoProvider.getName() + "\" via RESTful API", oldAuditContent, null);
+ return Response.ok().build();
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/rest/resource/UserResource.java b/server-core/src/main/java/io/onedev/server/rest/resource/UserResource.java
index 436e7d0c99..1532c7691b 100644
--- a/server-core/src/main/java/io/onedev/server/rest/resource/UserResource.java
+++ b/server-core/src/main/java/io/onedev/server/rest/resource/UserResource.java
@@ -42,10 +42,6 @@ import io.onedev.server.SubscriptionService;
import io.onedev.server.annotation.Password;
import io.onedev.server.annotation.UserName;
import io.onedev.server.data.migration.VersionedXmlDoc;
-import io.onedev.server.service.AuditService;
-import io.onedev.server.service.EmailAddressService;
-import io.onedev.server.service.SshKeyService;
-import io.onedev.server.service.UserService;
import io.onedev.server.model.AccessToken;
import io.onedev.server.model.BuildQueryPersonalization;
import io.onedev.server.model.CodeCommentQueryPersonalization;
@@ -69,6 +65,10 @@ import io.onedev.server.model.support.pullrequest.NamedPullRequestQuery;
import io.onedev.server.rest.annotation.Api;
import io.onedev.server.rest.annotation.EntityCreate;
import io.onedev.server.security.SecurityUtils;
+import io.onedev.server.service.AuditService;
+import io.onedev.server.service.EmailAddressService;
+import io.onedev.server.service.SshKeyService;
+import io.onedev.server.service.UserService;
@Path("/users")
@Consumes(MediaType.APPLICATION_JSON)
@@ -334,9 +334,9 @@ public class UserResource {
throw new UnauthorizedException();
if (userService.findByName(data.getName()) != null)
- throw new ExplicitException("Login name is already used by another user");
+ throw new NotAcceptableException("Login name is already used by another user");
if (data.getType() == ORDINARY && emailAddressService.findByValue(data.getEmailAddress()) != null)
- throw new ExplicitException("Email address is already used by another user");
+ throw new NotAcceptableException("Email address is already used by another user");
User user = new User();
user.setType(data.getType());
@@ -373,7 +373,7 @@ public class UserResource {
User existingUser = userService.findByName(data.getName());
if (existingUser != null && !existingUser.equals(user))
- throw new ExplicitException("Login name is already used by another user");
+ throw new NotAcceptableException("Login name is already used by another user");
var oldData = new UserUpdateData();
oldData.setName(user.getName());