Fast forward

backend/src/routes/v2/auth.ts

@@ -5,7 +5,7 @@ import { requireMfaAuth, validateRequest } from "../../middleware";
 import { authController } from "../../controllers/v2";
 import { authLimiter } from "../../helpers/rateLimiter";
 
-router.post(
+router.post( // TODO: deprecate (moved to api/v3/auth/login1)
   "/login1",
   authLimiter,
   body("email").isString().trim().notEmpty(),
@@ -14,7 +14,7 @@ router.post(
   authController.login1
 );
 
-router.post(
+router.post( // TODO: deprecate (moved to api/v3/auth/login1)
   "/login2",
   authLimiter,
   body("email").isString().trim().notEmpty(),

backend/src/routes/v2/environment.ts

@@ -9,14 +9,14 @@ import {
 } from "../../middleware";
 import {
   ADMIN, 
-  AUTH_MODE_JWT,
-  MEMBER,
+  AuthMode,
+  MEMBER
 } from "../../variables";
 
 router.post(
   "/:workspaceId/environments",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT],
+    acceptedAuthModes: [AuthMode.JWT],
   }),
   requireWorkspaceAuth({
     acceptedRoles: [ADMIN, MEMBER],
@@ -32,7 +32,7 @@ router.post(
 router.put(
   "/:workspaceId/environments",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT],
+    acceptedAuthModes: [AuthMode.JWT],
   }),
   requireWorkspaceAuth({
     acceptedRoles: [ADMIN, MEMBER],
@@ -49,7 +49,7 @@ router.put(
 router.delete(
   "/:workspaceId/environments",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT],
+    acceptedAuthModes: [AuthMode.JWT],
   }),
   requireWorkspaceAuth({
     acceptedRoles: [ADMIN],
@@ -64,7 +64,7 @@ router.delete(
 router.get(
   "/:workspaceId/environments",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT],
+    acceptedAuthModes: [AuthMode.JWT],
   }),
   requireWorkspaceAuth({
     acceptedRoles: [MEMBER, ADMIN],

backend/src/routes/v2/organizations.ts

@@ -10,10 +10,9 @@ import { body, param } from "express-validator";
 import { 
     ACCEPTED, 
     ADMIN, 
-    AUTH_MODE_API_KEY, 
-    AUTH_MODE_JWT,
+    AuthMode,
     MEMBER,
-    OWNER,
+    OWNER
 } from "../../variables";
 import { organizationsController } from "../../controllers/v2";
 
@@ -24,7 +23,7 @@ router.get(
     param("organizationId").exists().trim(),
     validateRequest,
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY],
+        acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
     }),
     requireOrganizationAuth({
         acceptedRoles: [OWNER, ADMIN, MEMBER],
@@ -40,7 +39,7 @@ router.patch(
     body("role").exists().isString().trim().isIn([OWNER, ADMIN, MEMBER]),
     validateRequest,
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY],
+        acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
     }),
     requireOrganizationAuth({
         acceptedRoles: [OWNER, ADMIN],
@@ -59,7 +58,7 @@ router.delete(
     param("membershipId").exists().trim(),
     validateRequest,
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY],
+        acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
     }),
     requireOrganizationAuth({
         acceptedRoles: [OWNER, ADMIN],
@@ -77,7 +76,7 @@ router.get(
     param("organizationId").exists().trim(),
     validateRequest,
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY],
+        acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
     }),
     requireOrganizationAuth({
         acceptedRoles: [OWNER, ADMIN],
@@ -86,12 +85,12 @@ router.get(
     organizationsController.getOrganizationWorkspaces
 );
 
-router.get(
+router.get( // TODO endpoint: deprecate service accounts
     "/:organizationId/service-accounts",
     param("organizationId").exists().trim(),
     validateRequest,
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT],
+        acceptedAuthModes: [AuthMode.JWT]
     }),
     requireOrganizationAuth({
         acceptedRoles: [OWNER, ADMIN],

backend/src/routes/v2/secret.ts

@@ -1,4 +1,5 @@
 import express from "express";
+const router = express.Router();
 import { 
   requireAuth, 
   requireSecretAuth,
@@ -8,8 +9,7 @@ import {
 import { body, param, query } from "express-validator";
 import {
   ADMIN, 
-  AUTH_MODE_JWT,
-  AUTH_MODE_SERVICE_TOKEN,
+  AuthMode,
   MEMBER,
   PERMISSION_READ_SECRETS,
   PERMISSION_WRITE_SECRETS,
@@ -17,14 +17,12 @@ import {
 import { CreateSecretRequestBody, ModifySecretRequestBody } from "../../types/secret";
 import { secretController } from "../../controllers/v2";
 
-// note to devs: stop supporting these routes [deprecated]
+// note: endpoints deprecated in favor of v3/secrets
 
-const router = express.Router();
-
-router.post(
+router.post( // TODO endpoint: deprecate (moved to POST api/v3/secrets)
   "/batch-create/workspace/:workspaceId/environment/:environment",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT],
+    acceptedAuthModes: [AuthMode.JWT],
   }),
   requireWorkspaceAuth({
     acceptedRoles: [ADMIN, MEMBER],
@@ -39,9 +37,9 @@ router.post(
 );
 
 router.post(
-  "/workspace/:workspaceId/environment/:environment",
+  "/workspace/:workspaceId/environment/:environment", // TODO endpoint: deprecate (moved to POST api/v3/secrets)
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT],
+    acceptedAuthModes: [AuthMode.JWT],
   }),
   requireWorkspaceAuth({
     acceptedRoles: [ADMIN, MEMBER],
@@ -55,12 +53,12 @@ router.post(
   secretController.createSecret
 );
 
-router.get(
+router.get( // TODO endpoint: deprecate (moved to GET api/v3/secrets)
   "/workspace/:workspaceId",
   param("workspaceId").exists().trim(),
   query("environment").exists(),
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_SERVICE_TOKEN],
+    acceptedAuthModes: [AuthMode.JWT, AuthMode.SERVICE_TOKEN],
   }),
   requireWorkspaceAuth({
     acceptedRoles: [ADMIN, MEMBER],
@@ -71,10 +69,10 @@ router.get(
   secretController.getSecrets
 );
 
-router.get(
+router.get( // TODO endpoint: deprecate (moved to POST api/v3/secrets)
   "/:secretId",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_SERVICE_TOKEN],
+    acceptedAuthModes: [AuthMode.JWT, AuthMode.SERVICE_TOKEN],
   }),
   requireSecretAuth({
     acceptedRoles: [ADMIN, MEMBER],
@@ -84,10 +82,10 @@ router.get(
   secretController.getSecret
 );
 
-router.delete(
+router.delete( // TODO endpoint: deprecate (moved to DELETE api/v3/secrets)
   "/batch/workspace/:workspaceId/environment/:environmentName",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT],
+    acceptedAuthModes: [AuthMode.JWT],
   }),
   param("workspaceId").exists().isMongoId().trim(),
   param("environmentName").exists().trim(),
@@ -100,10 +98,10 @@ router.delete(
   secretController.deleteSecrets
 );
 
-router.delete(
+router.delete( // TODO endpoint: deprecate (moved to DELETE api/v3/secrets)
   "/:secretId",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT],
+    acceptedAuthModes: [AuthMode.JWT],
   }),
   requireSecretAuth({
     acceptedRoles: [ADMIN, MEMBER],
@@ -114,10 +112,10 @@ router.delete(
   secretController.deleteSecret
 );
 
-router.patch(
+router.patch( // TODO endpoint: deprecate (moved to PATCH api/v3/secrets)
   "/batch-modify/workspace/:workspaceId/environment/:environmentName",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT],
+    acceptedAuthModes: [AuthMode.JWT],
   }),
   body("secrets").exists().isArray().custom((secrets: ModifySecretRequestBody[]) => secrets.length > 0),
   param("workspaceId").exists().isMongoId().trim(),
@@ -130,10 +128,10 @@ router.patch(
   secretController.updateSecrets
 );
 
-router.patch(
+router.patch( // TODO endpoint: deprecate (moved to PATCH api/v3/secrets)
   "/workspace/:workspaceId/environment/:environmentName",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT],
+    acceptedAuthModes: [AuthMode.JWT],
   }),
   body("secret").isObject(),
   param("workspaceId").exists().isMongoId().trim(),

backend/src/routes/v2/secrets.ts

@@ -12,10 +12,7 @@ import { body, query } from "express-validator";
 import { secretsController } from "../../controllers/v2";
 import {
   ADMIN,
-  AUTH_MODE_API_KEY,
-  AUTH_MODE_JWT,
-  AUTH_MODE_SERVICE_ACCOUNT,
-  AUTH_MODE_SERVICE_TOKEN,
+  AuthMode,
   MEMBER,
   PERMISSION_READ_SECRETS,
   PERMISSION_WRITE_SECRETS,
@@ -24,10 +21,10 @@ import {
 } from "../../variables";
 import { BatchSecretRequest } from "../../types/secret";
 
-router.post(
+router.post( // TODO endpoint: strongly consider deprecation in favor of a single operation experience on dashboard
   "/batch",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY, AUTH_MODE_SERVICE_TOKEN]
+    acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY, AuthMode.SERVICE_TOKEN]
   }),
   requireWorkspaceAuth({
     acceptedRoles: [ADMIN, MEMBER],
@@ -59,7 +56,7 @@ router.post(
   secretsController.batchSecrets
 );
 
-router.post(
+router.post( // TODO endpoint: deprecate (moved to POST api/v3/secrets)
   "/",
   body("workspaceId").exists().isString().trim(),
   body("environment").exists().isString().trim(),
@@ -109,7 +106,7 @@ router.post(
     }),
   validateRequest,
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY, AUTH_MODE_SERVICE_TOKEN]
+    acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY, AuthMode.SERVICE_TOKEN]
   }),
   requireWorkspaceAuth({
     acceptedRoles: [ADMIN, MEMBER],
@@ -120,7 +117,7 @@ router.post(
   secretsController.createSecrets
 );
 
-router.get(
+router.get( // TODO endpoint: deprecate (moved to GET api/v3/secrets)
   "/",
   query("workspaceId").exists().trim(),
   query("environment").exists().trim(),
@@ -130,12 +127,7 @@ router.get(
   query("include_imports").optional().default(false).isBoolean(),
   validateRequest,
   requireAuth({
-    acceptedAuthModes: [
-      AUTH_MODE_JWT,
-      AUTH_MODE_API_KEY,
-      AUTH_MODE_SERVICE_TOKEN,
-      AUTH_MODE_SERVICE_ACCOUNT
-    ]
+    acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY, AuthMode.SERVICE_TOKEN]
   }),
   requireWorkspaceAuth({
     acceptedRoles: [ADMIN, MEMBER],
@@ -146,7 +138,7 @@ router.get(
   secretsController.getSecrets
 );
 
-router.patch(
+router.patch( // TODO endpoint: deprecate (moved to PATCH api/v3/secrets)
   "/",
   body("secrets")
     .exists()
@@ -172,7 +164,7 @@ router.patch(
     }),
   validateRequest,
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY, AUTH_MODE_SERVICE_TOKEN]
+    acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY, AuthMode.SERVICE_TOKEN]
   }),
   requireSecretsAuth({
     acceptedRoles: [ADMIN, MEMBER],
@@ -181,7 +173,7 @@ router.patch(
   secretsController.updateSecrets
 );
 
-router.delete(
+router.delete( // TODO endpoint: deprecate (moved to DELETE api/v3/secrets)
   "/",
   body("secretIds")
     .exists()
@@ -201,7 +193,7 @@ router.delete(
     .isEmpty(),
   validateRequest,
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY, AUTH_MODE_SERVICE_TOKEN]
+    acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY, AuthMode.SERVICE_TOKEN]
   }),
   requireSecretsAuth({
     acceptedRoles: [ADMIN, MEMBER],

backend/src/routes/v2/serviceAccounts.ts

@@ -1,159 +1,161 @@
 import express from "express";
 const router = express.Router();
-import {
-    requireAuth,
-    requireOrganizationAuth,
-    requireServiceAccountAuth,
-    requireServiceAccountWorkspacePermissionAuth,
-    requireWorkspaceAuth,
-    validateRequest,
-} from "../../middleware";
-import { body, param, query } from "express-validator";
-import {
-    ACCEPTED,
-    ADMIN,
-    AUTH_MODE_JWT,
-    AUTH_MODE_SERVICE_ACCOUNT,
-    MEMBER,
-    OWNER,
-} from "../../variables";
-import { serviceAccountsController } from "../../controllers/v2";
 
-router.get( // TODO: check
-    "/me",
-    requireAuth({
-        acceptedAuthModes: [AUTH_MODE_SERVICE_ACCOUNT],
-    }),
-    serviceAccountsController.getCurrentServiceAccount
-);
+// TODO endpoint: deprecate all
 
-router.get(
-    "/:serviceAccountId",
-    param("serviceAccountId").exists().isString().trim(),
-    requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT],
-    }),
-    requireServiceAccountAuth({
-        acceptedRoles: [OWNER, ADMIN],
-        acceptedStatuses: [ACCEPTED],
-    }),
-    serviceAccountsController.getServiceAccountById
-);
+// import {
+//     requireAuth,
+//     requireOrganizationAuth,
+//     requireServiceAccountAuth,
+//     requireServiceAccountWorkspacePermissionAuth,
+//     requireWorkspaceAuth,
+//     validateRequest,
+// } from "../../middleware";
+// import { body, param, query } from "express-validator";
+// import {
+//     ACCEPTED,
+//     ADMIN,
+//     MEMBER,
+//     OWNER,
+//     AuthMode
+// } from "../../variables";
+// import { serviceAccountsController } from "../../controllers/v2";
 
-router.post(
-    "/",
-    body("organizationId").exists().isString().trim(),
-    body("name").exists().isString().trim(),
-    body("publicKey").exists().isString().trim(),
-    body("expiresIn").isNumeric(), // measured in ms
-    validateRequest,
-    requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT],
-    }),
-    requireOrganizationAuth({
-        acceptedRoles: [OWNER, ADMIN, MEMBER],
-        acceptedStatuses: [ACCEPTED],
-        locationOrganizationId: "body",
-    }),
-    serviceAccountsController.createServiceAccount
-);
+// router.get( // TODO: check
+//     "/me",
+//     requireAuth({
+//         acceptedAuthModes: [AUTH_MODE_SERVICE_ACCOUNT],
+//     }),
+//     serviceAccountsController.getCurrentServiceAccount
+// );
 
-router.patch(
-    "/:serviceAccountId/name",
-    param("serviceAccountId").exists().isString().trim(),
-    validateRequest,
-    requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT],
-    }),
-    requireServiceAccountAuth({
-        acceptedRoles: [OWNER, ADMIN],
-        acceptedStatuses: [ACCEPTED],
-    }),
-    serviceAccountsController.changeServiceAccountName
-);
+// router.get(
+//     "/:serviceAccountId",
+//     param("serviceAccountId").exists().isString().trim(),
+//     requireAuth({
+//         acceptedAuthModes: [AUTH_MODE_JWT],
+//     }),
+//     requireServiceAccountAuth({
+//         acceptedRoles: [OWNER, ADMIN],
+//         acceptedStatuses: [ACCEPTED],
+//     }),
+//     serviceAccountsController.getServiceAccountById
+// );
 
-router.delete(
-    "/:serviceAccountId",
-    param("serviceAccountId").exists().isString().trim(),
-    validateRequest,
-    requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT],
-    }),
-    requireServiceAccountAuth({
-        acceptedRoles: [OWNER, ADMIN],
-        acceptedStatuses: [ACCEPTED],
-    }),
-    serviceAccountsController.deleteServiceAccount
-);
+// router.post(
+//     "/",
+//     body("organizationId").exists().isString().trim(),
+//     body("name").exists().isString().trim(),
+//     body("publicKey").exists().isString().trim(),
+//     body("expiresIn").isNumeric(), // measured in ms
+//     validateRequest,
+//     requireAuth({
+//         acceptedAuthModes: [AUTH_MODE_JWT],
+//     }),
+//     requireOrganizationAuth({
+//         acceptedRoles: [OWNER, ADMIN, MEMBER],
+//         acceptedStatuses: [ACCEPTED],
+//         locationOrganizationId: "body",
+//     }),
+//     serviceAccountsController.createServiceAccount
+// );
 
-router.get(
-    "/:serviceAccountId/permissions/workspace",
-    param("serviceAccountId").exists().isString().trim(),
-    validateRequest,
-    requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT],
-    }),
-    requireServiceAccountAuth({
-        acceptedRoles: [OWNER, ADMIN],
-        acceptedStatuses: [ACCEPTED],
-    }),
-    serviceAccountsController.getServiceAccountWorkspacePermissions
-);
+// router.patch(
+//     "/:serviceAccountId/name",
+//     param("serviceAccountId").exists().isString().trim(),
+//     validateRequest,
+//     requireAuth({
+//         acceptedAuthModes: [AUTH_MODE_JWT],
+//     }),
+//     requireServiceAccountAuth({
+//         acceptedRoles: [OWNER, ADMIN],
+//         acceptedStatuses: [ACCEPTED],
+//     }),
+//     serviceAccountsController.changeServiceAccountName
+// );
 
-router.post(
-    "/:serviceAccountId/permissions/workspace",
-    param("serviceAccountId").exists().isString().trim(),
-    body("workspaceId").exists().isString().notEmpty(),
-    body("environment").exists().isString().notEmpty(),
-    body("read").isBoolean().optional(),
-    body("write").isBoolean().optional(),
-    body("encryptedKey").exists().isString().notEmpty(),
-    body("nonce").exists().isString().notEmpty(),
-    validateRequest,
-    requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT],
-    }),
-    requireServiceAccountAuth({
-        acceptedRoles: [OWNER, ADMIN],
-        acceptedStatuses: [ACCEPTED],
-    }),
-    requireWorkspaceAuth({
-        acceptedRoles: [ADMIN, MEMBER],
-        locationWorkspaceId: "body",
-    }),
-    serviceAccountsController.addServiceAccountWorkspacePermission 
-);
+// router.delete(
+//     "/:serviceAccountId",
+//     param("serviceAccountId").exists().isString().trim(),
+//     validateRequest,
+//     requireAuth({
+//         acceptedAuthModes: [AUTH_MODE_JWT],
+//     }),
+//     requireServiceAccountAuth({
+//         acceptedRoles: [OWNER, ADMIN],
+//         acceptedStatuses: [ACCEPTED],
+//     }),
+//     serviceAccountsController.deleteServiceAccount
+// );
 
-router.delete(
-    "/:serviceAccountId/permissions/workspace/:serviceAccountWorkspacePermissionId",
-    param("serviceAccountId").exists().isString().trim(),
-    param("serviceAccountWorkspacePermissionId").exists().isString().trim(),
-    validateRequest,
-    requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT],
-    }),
-    requireServiceAccountAuth({
-        acceptedRoles: [OWNER, ADMIN],
-        acceptedStatuses: [ACCEPTED],
-    }), 
-    requireServiceAccountWorkspacePermissionAuth({
-        acceptedRoles: [OWNER, ADMIN],
-        acceptedStatuses: [ACCEPTED],
-    }),
-    serviceAccountsController.deleteServiceAccountWorkspacePermission
-);
+// router.get(
+//     "/:serviceAccountId/permissions/workspace",
+//     param("serviceAccountId").exists().isString().trim(),
+//     validateRequest,
+//     requireAuth({
+//         acceptedAuthModes: [AUTH_MODE_JWT],
+//     }),
+//     requireServiceAccountAuth({
+//         acceptedRoles: [OWNER, ADMIN],
+//         acceptedStatuses: [ACCEPTED],
+//     }),
+//     serviceAccountsController.getServiceAccountWorkspacePermissions
+// );
 
-router.get(
-    "/:serviceAccountId/keys",
-    query("workspaceId").optional().isString(),
-    requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_SERVICE_ACCOUNT],
-    }),
-    requireServiceAccountAuth({
-        acceptedRoles: [OWNER, ADMIN],
-        acceptedStatuses: [ACCEPTED],
-    }), 
-    serviceAccountsController.getServiceAccountKeys
-);
+// router.post(
+//     "/:serviceAccountId/permissions/workspace",
+//     param("serviceAccountId").exists().isString().trim(),
+//     body("workspaceId").exists().isString().notEmpty(),
+//     body("environment").exists().isString().notEmpty(),
+//     body("read").isBoolean().optional(),
+//     body("write").isBoolean().optional(),
+//     body("encryptedKey").exists().isString().notEmpty(),
+//     body("nonce").exists().isString().notEmpty(),
+//     validateRequest,
+//     requireAuth({
+//         acceptedAuthModes: [AUTH_MODE_JWT],
+//     }),
+//     requireServiceAccountAuth({
+//         acceptedRoles: [OWNER, ADMIN],
+//         acceptedStatuses: [ACCEPTED],
+//     }),
+//     requireWorkspaceAuth({
+//         acceptedRoles: [ADMIN, MEMBER],
+//         locationWorkspaceId: "body",
+//     }),
+//     serviceAccountsController.addServiceAccountWorkspacePermission 
+// );
+
+// router.delete(
+//     "/:serviceAccountId/permissions/workspace/:serviceAccountWorkspacePermissionId",
+//     param("serviceAccountId").exists().isString().trim(),
+//     param("serviceAccountWorkspacePermissionId").exists().isString().trim(),
+//     validateRequest,
+//     requireAuth({
+//         acceptedAuthModes: [AUTH_MODE_JWT],
+//     }),
+//     requireServiceAccountAuth({
+//         acceptedRoles: [OWNER, ADMIN],
+//         acceptedStatuses: [ACCEPTED],
+//     }), 
+//     requireServiceAccountWorkspacePermissionAuth({
+//         acceptedRoles: [OWNER, ADMIN],
+//         acceptedStatuses: [ACCEPTED],
+//     }),
+//     serviceAccountsController.deleteServiceAccountWorkspacePermission
+// );
+
+// router.get(
+//     "/:serviceAccountId/keys",
+//     query("workspaceId").optional().isString(),
+//     requireAuth({
+//         acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_SERVICE_ACCOUNT],
+//     }),
+//     requireServiceAccountAuth({
+//         acceptedRoles: [OWNER, ADMIN],
+//         acceptedStatuses: [ACCEPTED],
+//     }), 
+//     serviceAccountsController.getServiceAccountKeys
+// );
 
 export default router;

backend/src/routes/v2/serviceTokenData.ts

@@ -9,9 +9,7 @@ import {
 import { body, param } from "express-validator";
 import {
   ADMIN,
-  AUTH_MODE_JWT,
-  AUTH_MODE_SERVICE_ACCOUNT,
-  AUTH_MODE_SERVICE_TOKEN,
+  AuthMode,
   MEMBER,
   PERMISSION_WRITE_SECRETS
 } from "../../variables";
@@ -20,7 +18,7 @@ import { serviceTokenDataController } from "../../controllers/v2";
 router.get(
   "/",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_SERVICE_TOKEN]
+    acceptedAuthModes: [AuthMode.SERVICE_TOKEN]
   }),
   serviceTokenDataController.getServiceTokenData
 );
@@ -28,7 +26,7 @@ router.get(
 router.post(
   "/",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_SERVICE_ACCOUNT]
+    acceptedAuthModes: [AuthMode.JWT]
   }),
   requireWorkspaceAuth({
     acceptedRoles: [ADMIN, MEMBER],
@@ -63,7 +61,7 @@ router.post(
 router.delete(
   "/:serviceTokenDataId",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT]
+    acceptedAuthModes: [AuthMode.JWT]
   }),
   requireServiceTokenDataAuth({
     acceptedRoles: [ADMIN, MEMBER]

backend/src/routes/v2/signup.ts

@@ -6,7 +6,7 @@ import { signupController } from "../../controllers/v2";
 import { authLimiter } from "../../helpers/rateLimiter";
 
 router.post(
-    "/complete-account/signup",
+    "/complete-account/signup", // TODO endpoint: deprecate (moved to v3/signup/complete/account-signup)
     authLimiter,
     requireSignupAuth,
     body("email").exists().isString().trim().notEmpty().isEmail(),
@@ -27,7 +27,7 @@ router.post(
 );
 
 router.post(
-	"/complete-account/invite",
+	"/complete-account/invite", // TODO: consider moving to v3/users/new/complete-account/invite
 	authLimiter,
 	requireSignupAuth,
 	body("email").exists().isString().trim().notEmpty().isEmail(),

backend/src/routes/v2/tags.ts

@@ -9,14 +9,14 @@ import {
 } from "../../middleware";
 import { 
   ADMIN, 
-  AUTH_MODE_JWT,
-  MEMBER,
+  AuthMode,
+  MEMBER
 } from "../../variables";
 
 router.get(
   "/:workspaceId/tags",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT],
+    acceptedAuthModes: [AuthMode.JWT],
   }),
   requireWorkspaceAuth({
     acceptedRoles: [MEMBER, ADMIN],
@@ -30,7 +30,7 @@ router.get(
 router.delete(
   "/tags/:tagId",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT],
+    acceptedAuthModes: [AuthMode.JWT],
   }),
   param("tagId").exists().trim(),
   validateRequest,
@@ -40,7 +40,7 @@ router.delete(
 router.post(
   "/:workspaceId/tags",
   requireAuth({
-    acceptedAuthModes: [AUTH_MODE_JWT],
+    acceptedAuthModes: [AuthMode.JWT],
   }),
   requireWorkspaceAuth({
     acceptedRoles: [MEMBER, ADMIN],

backend/src/routes/v2/users.ts

@@ -6,10 +6,7 @@ import {
 } from "../../middleware";
 import { body, param } from "express-validator";
 import { usersController } from "../../controllers/v2";
-import {
-    AUTH_MODE_API_KEY,
-    AUTH_MODE_JWT,
-} from "../../variables";
+import { AuthMode } from "../../variables";
 import {
     AuthProvider
 } from "../../models";
@@ -17,7 +14,7 @@ import {
 router.get(
     "/me",
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY],
+        acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
     }),
     usersController.getMe
 );
@@ -25,7 +22,7 @@ router.get(
 router.patch(
     "/me/mfa",
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY],
+        acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
     }),
     body("isMfaEnabled").exists().isBoolean(),
     validateRequest,
@@ -35,7 +32,7 @@ router.patch(
 router.patch(
     "/me/name",
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY],
+        acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
     }),
     body("firstName").exists().isString(),
     body("lastName").isString(),
@@ -46,7 +43,7 @@ router.patch(
 router.patch(
     "/me/auth-provider",
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY],
+        acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
     }),
     body("authProvider").exists().isString().isIn([
         AuthProvider.EMAIL,
@@ -78,7 +75,7 @@ router.put(
 router.get(
     "/me/organizations",
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY],
+        acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
     }),
     usersController.getMyOrganizations
 );
@@ -86,7 +83,7 @@ router.get(
 router.get(
     "/me/api-keys",
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT],
+        acceptedAuthModes: [AuthMode.JWT]
     }),
     usersController.getMyAPIKeys
 );
@@ -94,7 +91,7 @@ router.get(
 router.post(
     "/me/api-keys",
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT],
+        acceptedAuthModes: [AuthMode.JWT]
     }),
     body("name").exists().isString().trim(),
     body("expiresIn").isNumeric(),
@@ -105,7 +102,7 @@ router.post(
 router.delete(
     "/me/api-keys/:apiKeyDataId",
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT],
+        acceptedAuthModes: [AuthMode.JWT]
     }),
     param("apiKeyDataId").exists().trim(),
     validateRequest,
@@ -115,7 +112,7 @@ router.delete(
 router.get(
     "/me/sessions",
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT],
+        acceptedAuthModes: [AuthMode.JWT]
     }), 
     usersController.getMySessions
 );
@@ -123,7 +120,7 @@ router.get(
 router.delete(
     "/me/sessions",
     requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT],
+        acceptedAuthModes: [AuthMode.JWT]
     }), 
     usersController.deleteMySessions
 );

backend/src/routes/v2/workspace.ts

@@ -9,17 +9,15 @@ import {
 } from "../../middleware";
 import {
 	ADMIN, 
-	AUTH_MODE_API_KEY,
-	AUTH_MODE_JWT,
-	AUTH_MODE_SERVICE_TOKEN,
-	MEMBER,
+	AuthMode,
+	MEMBER
 } from "../../variables";
 import { workspaceController } from "../../controllers/v2";
 
-router.post(
+router.post( // TODO endpoint: deprecate (moved to POST v3/secrets)
 	"/:workspaceId/secrets",
 	requireAuth({
-		acceptedAuthModes: [AUTH_MODE_JWT],
+		acceptedAuthModes: [AuthMode.JWT],
 	}),
 	requireWorkspaceAuth({
 		acceptedRoles: [ADMIN, MEMBER],
@@ -34,10 +32,10 @@ router.post(
 	workspaceController.pushWorkspaceSecrets
 );
 
-router.get(
+router.get( // TODO endpoint: deprecate (moved to GET v3/secrets)
 	"/:workspaceId/secrets",
 	requireAuth({
-		acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_SERVICE_TOKEN],
+		acceptedAuthModes: [AuthMode.JWT, AuthMode.SERVICE_TOKEN],
 	}),
 	requireWorkspaceAuth({
 		acceptedRoles: [ADMIN, MEMBER],
@@ -50,10 +48,10 @@ router.get(
 	workspaceController.pullSecrets
 );
 
-router.get(
+router.get( // TODO endpoint: consider moving to v3/users/me/workspaces/:workspaceId/key
 	"/:workspaceId/encrypted-key",
 	requireAuth({
-		acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY],
+		acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
 	}),
 	requireWorkspaceAuth({
 		acceptedRoles: [ADMIN, MEMBER],
@@ -67,7 +65,7 @@ router.get(
 router.get(
 	"/:workspaceId/service-token-data",
 	requireAuth({
-		acceptedAuthModes: [AUTH_MODE_JWT],
+		acceptedAuthModes: [AuthMode.JWT],
 	}),
 	requireWorkspaceAuth({
 		acceptedRoles: [ADMIN, MEMBER],
@@ -83,7 +81,7 @@ router.get( // new - TODO: rewire dashboard to this route
 	param("workspaceId").exists().trim(),
 	validateRequest,
 	requireAuth({
-		acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY],
+		acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
 	}),
 	requireWorkspaceAuth({
 		acceptedRoles: [ADMIN, MEMBER],
@@ -99,7 +97,7 @@ router.patch( // TODO - rewire dashboard to this route
 	body("role").exists().isString().trim().isIn([ADMIN, MEMBER]),
 	validateRequest,
 	requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY],
+        acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
     }),
 	requireWorkspaceAuth({
 		acceptedRoles: [ADMIN],
@@ -118,7 +116,7 @@ router.delete( // TODO - rewire dashboard to this route
 	param("membershipId").exists().trim(),
 	validateRequest,
 	requireAuth({
-        acceptedAuthModes: [AUTH_MODE_JWT, AUTH_MODE_API_KEY],
+        acceptedAuthModes: [AuthMode.JWT, AuthMode.API_KEY],
     }),
 	requireWorkspaceAuth({
 		acceptedRoles: [ADMIN],
@@ -134,7 +132,7 @@ router.delete( // TODO - rewire dashboard to this route
 router.patch(
 	"/:workspaceId/auto-capitalization",
 	requireAuth({
-		acceptedAuthModes: [AUTH_MODE_JWT],
+		acceptedAuthModes: [AuthMode.JWT]
 	}),
 	requireWorkspaceAuth({
 		acceptedRoles: [ADMIN, MEMBER],