Merge pull request #299 from AuthGuard/refactor/endpoints

Make all relevant services domain-scoped
AuthGuard · Jan 27, 2024 · 3bc0be6 · 3bc0be6
2 parents a0460e4 + 5ff486f
commit 3bc0be6
Show file tree

Hide file tree

Showing 126 changed files with 930 additions and 727 deletions.
diff --git a/api/pom.xml b/api/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <artifactId>authguard</artifactId>
         <groupId>com.nexblocks.authguard</groupId>
-        <version>0.21.0</version>
+        <version>0.22.0</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/entities/Account.java b/api/src/main/java/com/nexblocks/authguard/api/dto/entities/Account.java
@@ -14,8 +14,8 @@
 @DTOStyle
 @JsonSerialize(as = AccountDTO.class)
 @JsonDeserialize(as = AccountDTO.class)
-public interface Account {
-    long getId();
+public interface Account extends DomainScoped {
+    String getId();
     Instant getCreatedAt();
     Instant getLastModified();
 
@@ -28,7 +28,6 @@ public interface Account {
     String getMiddleName();
     String getLastName();
     String getFullName();
-    String getDomain();
 
     List<PermissionDTO> getPermissions();
     List<String> getRoles();

diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/entities/AccountLock.java b/api/src/main/java/com/nexblocks/authguard/api/dto/entities/AccountLock.java
@@ -8,6 +8,6 @@
 @Value.Immutable
 @DTOStyle
 public interface AccountLock {
-    long getAccountId();
+    String getAccountId();
     Instant getExpiresAt();
 }
diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/entities/ActionToken.java b/api/src/main/java/com/nexblocks/authguard/api/dto/entities/ActionToken.java
@@ -12,6 +12,6 @@
 public interface ActionToken {
     String getToken();
     String getAction();
-    Long getAccountId();
+    String getAccountId();
     long getValidFor();
 }
diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/entities/ApiKey.java b/api/src/main/java/com/nexblocks/authguard/api/dto/entities/ApiKey.java
@@ -12,12 +12,13 @@
 @JsonSerialize(as = ApiKeyDTO.class)
 @JsonDeserialize(as = ApiKeyDTO.class)
 public interface ApiKey {
-    long getId();
+    String getId();
     Instant getCreatedAt();
     Instant getLastModified();
-    Long getAppId();
+    String getAppId();
     String getKey();
     String getType();
+    String getName();
     boolean isForClient();
     Instant getExpiresAt();
 }
diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/entities/App.java b/api/src/main/java/com/nexblocks/authguard/api/dto/entities/App.java
@@ -12,14 +12,13 @@
 @DTOStyle
 @JsonSerialize(as = AppDTO.class)
 @JsonDeserialize(as = AppDTO.class)
-public interface App {
-    long getId();
+public interface App extends DomainScoped {
+    String getId();
     Instant getCreatedAt();
     Instant getLastModified();
     String getExternalId();
     String getName();
-    Long getAccountId();
-    String getDomain();
+    String getAccountId();
     String getBaseUrl();
     List<PermissionDTO> getPermissions();
     List<String> getRoles();

diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/entities/Client.java b/api/src/main/java/com/nexblocks/authguard/api/dto/entities/Client.java
@@ -11,14 +11,13 @@
 @DTOStyle
 @JsonSerialize(as = ClientDTO.class)
 @JsonDeserialize(as = ClientDTO.class)
-public interface Client {
-    long getId();
+public interface Client extends DomainScoped {
+    String getId();
     Instant getCreatedAt();
     Instant getLastModified();
     String getExternalId();
     String getName();
-    Long getAccountId();
-    String getDomain();
+    String getAccountId();
     String getBaseUrl();
     String getClientType();
     boolean isActive();

diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/entities/Credentials.java b/api/src/main/java/com/nexblocks/authguard/api/dto/entities/Credentials.java
@@ -11,7 +11,7 @@
 @DTOStyle
 @JsonDeserialize(as = CredentialsDTO.class)
 public interface Credentials {
-    long getId();
+    String getId();
     Instant getCreatedAt();
     Instant getLastModified();
     Instant getPasswordUpdatedAt();

diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/entities/DomainScoped.java b/api/src/main/java/com/nexblocks/authguard/api/dto/entities/DomainScoped.java
@@ -0,0 +1,5 @@
+package com.nexblocks.authguard.api.dto.entities;
+
+public interface DomainScoped {
+    String getDomain();
+}
diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/entities/ExchangeAttempt.java b/api/src/main/java/com/nexblocks/authguard/api/dto/entities/ExchangeAttempt.java
@@ -8,10 +8,10 @@
 @Value.Immutable
 @DTOStyle
 public interface ExchangeAttempt {
-    long getId();
+    String getId();
     Instant getCreatedAt();
     Instant getLastModified();
-    Long getEntityId();
+    String getEntityId();
     String getExchangeFrom();
     String getExchangeTo();
     boolean isSuccessful();

diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/entities/Permission.java b/api/src/main/java/com/nexblocks/authguard/api/dto/entities/Permission.java
@@ -11,11 +11,10 @@
 @DTOStyle
 @JsonSerialize(as = PermissionDTO.class)
 @JsonDeserialize(as = PermissionDTO.class)
-public interface Permission {
-    long getId();
+public interface Permission extends DomainScoped {
+    String getId();
     Instant getCreatedAt();
     Instant getLastModified();
     String getGroup();
     String getName();
-    String getDomain();
 }
diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/entities/Role.java b/api/src/main/java/com/nexblocks/authguard/api/dto/entities/Role.java
@@ -11,10 +11,9 @@
 @DTOStyle
 @JsonDeserialize(as = RoleDTO.class)
 @JsonSerialize(as = RoleDTO.class)
-public interface Role {
-    long getId();
+public interface Role extends DomainScoped {
+    String getId();
     Instant getCreatedAt();
     Instant getLastModified();
     String getName();
-    String getDomain();
 }
diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/entities/UserIdentifier.java b/api/src/main/java/com/nexblocks/authguard/api/dto/entities/UserIdentifier.java
@@ -9,10 +9,9 @@
 @DTOStyle
 @JsonSerialize(as = UserIdentifierDTO.class)
 @JsonDeserialize(as = UserIdentifierDTO.class)
-public interface UserIdentifier {
+public interface UserIdentifier extends DomainScoped {
     Type getType();
     String getIdentifier();
-    String getDomain();
 
     @Value.Default
     default boolean isActive() {

diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/requests/ApiKeyRequest.java b/api/src/main/java/com/nexblocks/authguard/api/dto/requests/ApiKeyRequest.java
@@ -14,7 +14,8 @@
 public interface ApiKeyRequest {
     boolean isForClient();
     String getKeyType();
-    Long getAppId();
+    String getAppId();
+    String getName();
     Instant getExpiresAt();
     DurationRequestDTO getValidFor();
 }
diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/requests/CreateAccountRequest.java b/api/src/main/java/com/nexblocks/authguard/api/dto/requests/CreateAccountRequest.java
@@ -2,10 +2,7 @@
 
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
-import com.nexblocks.authguard.api.dto.entities.AccountEmailDTO;
-import com.nexblocks.authguard.api.dto.entities.PermissionDTO;
-import com.nexblocks.authguard.api.dto.entities.PhoneNumberDTO;
-import com.nexblocks.authguard.api.dto.entities.UserIdentifierDTO;
+import com.nexblocks.authguard.api.dto.entities.*;
 import com.nexblocks.authguard.api.dto.style.DTOStyle;
 import org.immutables.value.Value;
 
@@ -16,14 +13,13 @@
 @DTOStyle
 @JsonDeserialize(as = CreateAccountRequestDTO.class)
 @JsonSerialize(as = CreateAccountRequestDTO.class)
-public interface CreateAccountRequest {
+public interface CreateAccountRequest extends DomainScoped {
     String getExternalId();
 
     String getFirstName();
     String getMiddleName();
     String getLastName();
     String getFullName();
-    String getDomain();
 
     AccountEmailDTO getEmail();
     AccountEmailDTO getBackupEmail();

diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/requests/CreateAppRequest.java b/api/src/main/java/com/nexblocks/authguard/api/dto/requests/CreateAppRequest.java
@@ -1,5 +1,6 @@
 package com.nexblocks.authguard.api.dto.requests;
 
+import com.nexblocks.authguard.api.dto.entities.DomainScoped;
 import com.nexblocks.authguard.api.dto.entities.PermissionDTO;
 import com.nexblocks.authguard.api.dto.style.DTOStyle;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
@@ -12,11 +13,10 @@
 @DTOStyle
 @JsonDeserialize(as = CreateAppRequestDTO.class)
 @JsonSerialize(as = CreateAppRequestDTO.class)
-public interface CreateAppRequest {
+public interface CreateAppRequest extends DomainScoped {
     String getExternalId();
     String getName();
-    Long getAccountId();
-    String getDomain();
+    String getAccountId();
     List<PermissionDTO> getPermissions();
     List<String> getScopes();
     List<String> getRoles();

diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/requests/CreateClientRequest.java b/api/src/main/java/com/nexblocks/authguard/api/dto/requests/CreateClientRequest.java
@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.nexblocks.authguard.api.dto.entities.DomainScoped;
 import com.nexblocks.authguard.api.dto.style.DTOStyle;
 import org.immutables.value.Value;
 
@@ -10,11 +11,10 @@
 @DTOStyle
 @JsonDeserialize(as = CreateClientRequestDTO.class)
 @JsonSerialize(as = CreateClientRequestDTO.class)
-public interface CreateClientRequest {
+public interface CreateClientRequest extends DomainScoped {
     String getExternalId();
     String getName();
     Long getAccountId();
-    String getDomain();
     String getBaseUrl();
     ClientType getClientType();
 

diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/requests/CreatePermissionRequest.java b/api/src/main/java/com/nexblocks/authguard/api/dto/requests/CreatePermissionRequest.java
@@ -2,15 +2,15 @@
 
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.nexblocks.authguard.api.dto.entities.DomainScoped;
 import com.nexblocks.authguard.api.dto.style.DTOStyle;
 import org.immutables.value.Value;
 
 @Value.Immutable
 @DTOStyle
 @JsonSerialize(as = CreatePermissionRequestDTO.class)
 @JsonDeserialize(as = CreatePermissionRequestDTO.class)
-public interface CreatePermissionRequest {
+public interface CreatePermissionRequest extends DomainScoped {
     String getGroup();
     String getName();
-    String getDomain();
 }
diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/requests/CreateRoleRequest.java b/api/src/main/java/com/nexblocks/authguard/api/dto/requests/CreateRoleRequest.java
@@ -1,5 +1,6 @@
 package com.nexblocks.authguard.api.dto.requests;
 
+import com.nexblocks.authguard.api.dto.entities.DomainScoped;
 import com.nexblocks.authguard.api.dto.style.DTOStyle;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
@@ -9,7 +10,6 @@
 @DTOStyle
 @JsonDeserialize(as = CreateRoleRequestDTO.class)
 @JsonSerialize(as = CreateRoleRequestDTO.class)
-public interface CreateRoleRequest {
+public interface CreateRoleRequest extends DomainScoped {
     String getName();
-    String getDomain();
 }
diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/requests/OtpRequest.java b/api/src/main/java/com/nexblocks/authguard/api/dto/requests/OtpRequest.java
@@ -10,6 +10,6 @@
 @JsonDeserialize(as = OtpRequestDTO.class)
 @JsonSerialize(as = OtpRequestDTO.class)
 public interface OtpRequest {
-    Long getPasswordId();
+    String getPasswordId();
     String getPassword();
 }
diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/requests/PasswordResetRequest.java b/api/src/main/java/com/nexblocks/authguard/api/dto/requests/PasswordResetRequest.java
@@ -2,18 +2,18 @@
 
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.nexblocks.authguard.api.dto.entities.DomainScoped;
 import com.nexblocks.authguard.api.dto.style.DTOStyle;
 import org.immutables.value.Value;
 
 @Value.Immutable
 @DTOStyle
 @JsonSerialize(as = PasswordResetRequestDTO.class)
 @JsonDeserialize(as = PasswordResetRequestDTO.class)
-public interface PasswordResetRequest {
+public interface PasswordResetRequest extends DomainScoped {
     boolean isByToken();
     String getResetToken();
     String getIdentifier();
     String getOldPassword();
     String getNewPassword();
-    String getDomain();
 }
diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/requests/PasswordResetTokenRequest.java b/api/src/main/java/com/nexblocks/authguard/api/dto/requests/PasswordResetTokenRequest.java
@@ -2,14 +2,14 @@
 
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.nexblocks.authguard.api.dto.entities.DomainScoped;
 import com.nexblocks.authguard.api.dto.style.DTOStyle;
 import org.immutables.value.Value;
 
 @Value.Immutable
 @DTOStyle
 @JsonSerialize(as = PasswordResetTokenRequestDTO.class)
 @JsonDeserialize(as = PasswordResetTokenRequestDTO.class)
-public interface PasswordResetTokenRequest {
+public interface PasswordResetTokenRequest extends DomainScoped {
     String getIdentifier();
-    String getDomain();
 }
diff --git a/api/src/main/java/com/nexblocks/authguard/api/dto/validation/IdParser.java b/api/src/main/java/com/nexblocks/authguard/api/dto/validation/IdParser.java
@@ -0,0 +1,14 @@
+package com.nexblocks.authguard.api.dto.validation;
+
+import com.nexblocks.authguard.service.exceptions.ServiceException;
+import com.nexblocks.authguard.service.exceptions.codes.ErrorCode;
+
+public class IdParser {
+    public static Long from(final String idString) {
+        try {
+            return Long.parseLong(idString);
+        } catch (NumberFormatException ex) {
+            throw new ServiceException(ErrorCode.INVALID_REQUEST_VALUE, "Value '" + idString + "' is not a valid ID");
+        }
+    }
+}
diff --git a/.../com/nexblocks/authguard/api/dto/validation/validators/PasswordResetRequestValidator.java b/.../com/nexblocks/authguard/api/dto/validation/validators/PasswordResetRequestValidator.java
@@ -13,6 +13,7 @@ public class PasswordResetRequestValidator implements Validator<PasswordResetReq
     @Override
     public List<Violation> validate(final PasswordResetRequestDTO obj) {
         return FluentValidator.begin()
+                .validate("domain", obj.getDomain(), Constraints.required)
                 .validate("identifier", obj.getIdentifier(), identifier -> {
                     if (!obj.isByToken() && identifier == null) {
                         return Collections.singletonList(

diff --git a/api/src/main/java/com/nexblocks/authguard/api/routes/AccountsApi.java b/api/src/main/java/com/nexblocks/authguard/api/routes/AccountsApi.java
@@ -9,7 +9,7 @@ public abstract class AccountsApi implements ApiRoute {
 
     @Override
     public String getPath() {
-        return "accounts";
+        return "/domains/:domain/accounts";
     }
 
     public void addEndpoints() {
@@ -18,12 +18,12 @@ public void addEndpoints() {
         get("/:id", this::getById, ActorRoles.adminClient());
         delete("/:id", this::deleteAccount, ActorRoles.adminClient());
         patch("/:id", this::patchAccount, ActorRoles.adminClient());
-        get("/domain/:domain/identifier/:identifier", this::getByIdentifier, ActorRoles.adminClient());
-        get("/domain/:domain/identifier/:identifier/exists", this::identifierExists, ActorRoles.adminOrAuthClient());
+        get("/identifier/:identifier", this::getByIdentifier, ActorRoles.adminClient());
+        get("/identifier/:identifier/exists", this::identifierExists, ActorRoles.adminOrAuthClient());
 
         get("/externalId/:id", this::getByExternalId, ActorRoles.adminClient());
-        get("/domain/:domain/email/:email", this::getByEmail, ActorRoles.adminClient());
-        get("/domain/:domain/email/:email/exists", this::emailExists, ActorRoles.adminOrAuthClient());
+        get("/email/:email", this::getByEmail, ActorRoles.adminClient());
+        get("/email/:email/exists", this::emailExists, ActorRoles.adminOrAuthClient());
 
         patch("/:id/permissions", this::updatePermissions, ActorRoles.adminClient());
         patch("/:id/roles", this::updateRoles, ActorRoles.adminClient());

diff --git a/api/src/main/java/com/nexblocks/authguard/api/routes/ActionTokensApi.java b/api/src/main/java/com/nexblocks/authguard/api/routes/ActionTokensApi.java
@@ -8,7 +8,7 @@
 public abstract class ActionTokensApi implements ApiRoute {
     @Override
     public String getPath() {
-        return "actions";
+        return "/domains/:domain/actions";
     }
 
     @Override

diff --git a/api/src/main/java/com/nexblocks/authguard/api/routes/ApiKeysApi.java b/api/src/main/java/com/nexblocks/authguard/api/routes/ApiKeysApi.java
@@ -9,7 +9,7 @@ public abstract class ApiKeysApi implements ApiRoute {
 
     @Override
     public String getPath() {
-        return "keys";
+        return "/domains/:domain/keys";
     }
 
     @Override

diff --git a/api/src/main/java/com/nexblocks/authguard/api/routes/ApplicationsApi.java b/api/src/main/java/com/nexblocks/authguard/api/routes/ApplicationsApi.java
@@ -9,7 +9,7 @@ public abstract class ApplicationsApi implements ApiRoute {
 
     @Override
     public String getPath() {
-        return "apps";
+        return "/domains/:domain/apps";
     }
 
     @Override