[EC 784] Refactor organization user service (#4163)

* [EC-784] Introduce OrganizationUserService and abstraction

* [EC-784] Move API response models into abstraction folder

* [EC-784] Register OrganizationUserService in JsLib

* [EC-784] Add OrganizationUserService to CLI Main

* [EC-784] Move getOrganizationUser()

- Move getOrganizationUser() implementation to OrganizationUserService
- Update any references to the API service in the CLI and Web projects

* [EC-784] Move getOrganizationUserGroups()

* [EC-784] Move and rename getOrganizationUsers()

* [EC-784] Move getOrganizationUserResetPasswordDetails()

* [EC-784] Move OrganizationUser API request models into abstraction folder

* [EC-784] Move postOrganizationUserInvite()

* [EC-784] Move postOrganizationUserReinvite()

* [EC-784] Move postManyOrganizationUserReinvite()

Also tweak the signature to avoid exposing the API request model

* [EC-784] Move postOrganizationUserAccept()

* [EC-784] Move postOrganizationUserConfirm()

* [EC-784] Move postOrganizationUsersPublicKey()

Also modify signature to avoid exposing API request model

* [EC-784] Move postOrganizationUserBulkConfirm()

* [EC-784] Move putOrganizationUser()

* [EC-784] Move putOrganizationUserGroups()

* [EC-784] Update abstraction method definitions to use abstract keyword

* [EC-784] Move putOrganizationUserResetPasswordEnrollment()

* [EC-784] Move putOrganizationUserResetPassword()

* [EC-784] Move deleteOrganizationUser()

* [EC-784] Move deleteManyOrganizationUsers()

* [EC-784] Move revokeOrganizationUser()

* [EC-784] Move revokeManyOrganizationUsers()

* [EC-784] Move restoreOrganizationUser()

* [EC-784] Move restoreManyOrganizationUsers()

* [EC-784] Move internal OrganizationUserBulkRequest model out of service abstraction

* [EC-784] Rename organizationUser folder to organization-user

libs/common/src/abstractions/api.service.ts

@@ -34,15 +34,6 @@ import { KeyConnectorUserKeyRequest } from "../models/request/key-connector-user
 import { KeysRequest } from "../models/request/keys.request";
 import { OrganizationConnectionRequest } from "../models/request/organization-connection.request";
 import { OrganizationImportRequest } from "../models/request/organization-import.request";
-import { OrganizationUserAcceptRequest } from "../models/request/organization-user-accept.request";
-import { OrganizationUserBulkConfirmRequest } from "../models/request/organization-user-bulk-confirm.request";
-import { OrganizationUserBulkRequest } from "../models/request/organization-user-bulk.request";
-import { OrganizationUserConfirmRequest } from "../models/request/organization-user-confirm.request";
-import { OrganizationUserInviteRequest } from "../models/request/organization-user-invite.request";
-import { OrganizationUserResetPasswordEnrollmentRequest } from "../models/request/organization-user-reset-password-enrollment.request";
-import { OrganizationUserResetPasswordRequest } from "../models/request/organization-user-reset-password.request";
-import { OrganizationUserUpdateGroupsRequest } from "../models/request/organization-user-update-groups.request";
-import { OrganizationUserUpdateRequest } from "../models/request/organization-user-update.request";
 import { OrganizationSponsorshipCreateRequest } from "../models/request/organization/organization-sponsorship-create.request";
 import { OrganizationSponsorshipRedeemRequest } from "../models/request/organization/organization-sponsorship-redeem.request";
 import { PasswordHintRequest } from "../models/request/password-hint.request";
@@ -117,13 +108,6 @@ import {
 } from "../models/response/organization-connection.response";
 import { OrganizationExportResponse } from "../models/response/organization-export.response";
 import { OrganizationSponsorshipSyncStatusResponse } from "../models/response/organization-sponsorship-sync-status.response";
-import { OrganizationUserBulkPublicKeyResponse } from "../models/response/organization-user-bulk-public-key.response";
-import { OrganizationUserBulkResponse } from "../models/response/organization-user-bulk.response";
-import {
-  OrganizationUserDetailsResponse,
-  OrganizationUserUserDetailsResponse,
-  OrganizationUserResetPasswordDetailsReponse,
-} from "../models/response/organization-user.response";
 import { PaymentResponse } from "../models/response/payment.response";
 import { PlanResponse } from "../models/response/plan.response";
 import { PolicyResponse } from "../models/response/policy.response";
@@ -136,8 +120,8 @@ import {
 import { ProviderUserBulkPublicKeyResponse } from "../models/response/provider/provider-user-bulk-public-key.response";
 import { ProviderUserBulkResponse } from "../models/response/provider/provider-user-bulk.response";
 import {
-  ProviderUserUserDetailsResponse,
   ProviderUserResponse,
+  ProviderUserUserDetailsResponse,
 } from "../models/response/provider/provider-user.response";
 import { ProviderResponse } from "../models/response/provider/provider.response";
 import { SelectionReadOnlyResponse } from "../models/response/selection-read-only.response";
@@ -156,8 +140,8 @@ import { TwoFactorEmailResponse } from "../models/response/two-factor-email.resp
 import { TwoFactorProviderResponse } from "../models/response/two-factor-provider.response";
 import { TwoFactorRecoverResponse } from "../models/response/two-factor-recover.response";
 import {
-  TwoFactorWebAuthnResponse,
   ChallengeResponse,
+  TwoFactorWebAuthnResponse,
 } from "../models/response/two-factor-web-authn.response";
 import { TwoFactorYubiKeyResponse } from "../models/response/two-factor-yubi-key.response";
 import { UserKeyResponse } from "../models/response/user-key.response";
@@ -355,82 +339,6 @@ export abstract class ApiService {
   deleteGroup: (organizationId: string, id: string) => Promise<any>;
   deleteGroupUser: (organizationId: string, id: string, organizationUserId: string) => Promise<any>;
 
-  getOrganizationUser: (
-    organizationId: string,
-    id: string
-  ) => Promise<OrganizationUserDetailsResponse>;
-  getOrganizationUserGroups: (organizationId: string, id: string) => Promise<string[]>;
-  getOrganizationUsers: (
-    organizationId: string
-  ) => Promise<ListResponse<OrganizationUserUserDetailsResponse>>;
-  getOrganizationUserResetPasswordDetails: (
-    organizationId: string,
-    id: string
-  ) => Promise<OrganizationUserResetPasswordDetailsReponse>;
-  postOrganizationUserInvite: (
-    organizationId: string,
-    request: OrganizationUserInviteRequest
-  ) => Promise<any>;
-  postOrganizationUserReinvite: (organizationId: string, id: string) => Promise<any>;
-  postManyOrganizationUserReinvite: (
-    organizationId: string,
-    request: OrganizationUserBulkRequest
-  ) => Promise<ListResponse<OrganizationUserBulkResponse>>;
-  postOrganizationUserAccept: (
-    organizationId: string,
-    id: string,
-    request: OrganizationUserAcceptRequest
-  ) => Promise<any>;
-  postOrganizationUserConfirm: (
-    organizationId: string,
-    id: string,
-    request: OrganizationUserConfirmRequest
-  ) => Promise<any>;
-  postOrganizationUsersPublicKey: (
-    organizationId: string,
-    request: OrganizationUserBulkRequest
-  ) => Promise<ListResponse<OrganizationUserBulkPublicKeyResponse>>;
-  postOrganizationUserBulkConfirm: (
-    organizationId: string,
-    request: OrganizationUserBulkConfirmRequest
-  ) => Promise<ListResponse<OrganizationUserBulkResponse>>;
-
-  putOrganizationUser: (
-    organizationId: string,
-    id: string,
-    request: OrganizationUserUpdateRequest
-  ) => Promise<any>;
-  putOrganizationUserGroups: (
-    organizationId: string,
-    id: string,
-    request: OrganizationUserUpdateGroupsRequest
-  ) => Promise<any>;
-  putOrganizationUserResetPasswordEnrollment: (
-    organizationId: string,
-    userId: string,
-    request: OrganizationUserResetPasswordEnrollmentRequest
-  ) => Promise<void>;
-  putOrganizationUserResetPassword: (
-    organizationId: string,
-    id: string,
-    request: OrganizationUserResetPasswordRequest
-  ) => Promise<any>;
-  deleteOrganizationUser: (organizationId: string, id: string) => Promise<any>;
-  deleteManyOrganizationUsers: (
-    organizationId: string,
-    request: OrganizationUserBulkRequest
-  ) => Promise<ListResponse<OrganizationUserBulkResponse>>;
-  revokeOrganizationUser: (organizationId: string, id: string) => Promise<any>;
-  revokeManyOrganizationUsers: (
-    organizationId: string,
-    request: OrganizationUserBulkRequest
-  ) => Promise<ListResponse<OrganizationUserBulkResponse>>;
-  restoreOrganizationUser: (organizationId: string, id: string) => Promise<any>;
-  restoreManyOrganizationUsers: (
-    organizationId: string,
-    request: OrganizationUserBulkRequest
-  ) => Promise<ListResponse<OrganizationUserBulkResponse>>;
-
   getSync: () => Promise<SyncResponse>;
   postPublicImportDirectory: (request: OrganizationImportRequest) => Promise<any>;
 

libs/common/src/abstractions/organization-user/organization-user.service.ts

@@ -0,0 +1,233 @@
+import { ListResponse } from "../../models/response/list.response";
+
+import {
+  OrganizationUserAcceptRequest,
+  OrganizationUserBulkConfirmRequest,
+  OrganizationUserConfirmRequest,
+  OrganizationUserInviteRequest,
+  OrganizationUserResetPasswordEnrollmentRequest,
+  OrganizationUserResetPasswordRequest,
+  OrganizationUserUpdateGroupsRequest,
+  OrganizationUserUpdateRequest,
+} from "./requests";
+import {
+  OrganizationUserBulkPublicKeyResponse,
+  OrganizationUserBulkResponse,
+  OrganizationUserDetailsResponse,
+  OrganizationUserResetPasswordDetailsReponse,
+  OrganizationUserUserDetailsResponse,
+} from "./responses";
+
+/**
+ * Service for interacting with Organization Users via the API
+ */
+export abstract class OrganizationUserService {
+  /**
+   * Retrieve a single organization user by Id
+   * @param organizationId - Identifier for the user's organization
+   * @param id - Organization user identifier
+   */
+  abstract getOrganizationUser(
+    organizationId: string,
+    id: string
+  ): Promise<OrganizationUserDetailsResponse>;
+
+  /**
+   * Retrieve a list of groups Ids the specified organization user belongs to
+   * @param organizationId - Identifier for the user's organization
+   * @param id - Organization user identifier
+   */
+  abstract getOrganizationUserGroups(organizationId: string, id: string): Promise<string[]>;
+
+  /**
+   * Retrieve a list of all users that belong to the specified organization
+   * @param organizationId - Identifier for the organization
+   */
+  abstract getAllUsers(
+    organizationId: string
+  ): Promise<ListResponse<OrganizationUserUserDetailsResponse>>;
+
+  /**
+   * Retrieve reset password details for the specified organization user
+   * @param organizationId - Identifier for the user's organization
+   * @param id - Organization user identifier
+   */
+  abstract getOrganizationUserResetPasswordDetails(
+    organizationId: string,
+    id: string
+  ): Promise<OrganizationUserResetPasswordDetailsReponse>;
+
+  /**
+   * Create new organization user invite(s) for the specified organization
+   * @param organizationId - Identifier for the organization
+   * @param request - New user invitation request details
+   */
+  abstract postOrganizationUserInvite(
+    organizationId: string,
+    request: OrganizationUserInviteRequest
+  ): Promise<void>;
+
+  /**
+   * Re-invite the specified organization user
+   * @param organizationId - Identifier for the user's organization
+   * @param id - Organization user identifier
+   */
+  abstract postOrganizationUserReinvite(organizationId: string, id: string): Promise<any>;
+
+  /**
+   * Re-invite many organization users for the specified organization
+   * @param organizationId - Identifier for the organization
+   * @param ids - A list of organization user identifiers
+   * @return List of user ids, including both those that were successfully re-invited and those that had an error
+   */
+  abstract postManyOrganizationUserReinvite(
+    organizationId: string,
+    ids: string[]
+  ): Promise<ListResponse<OrganizationUserBulkResponse>>;
+
+  /**
+   * Accept an organization user invitation
+   * @param organizationId - Identifier for the organization to accept
+   * @param id - Organization user identifier
+   * @param request - Request details for accepting the invitation
+   */
+  abstract postOrganizationUserAccept(
+    organizationId: string,
+    id: string,
+    request: OrganizationUserAcceptRequest
+  ): Promise<void>;
+
+  /**
+   * Confirm an organization user that has accepted their invitation
+   * @param organizationId - Identifier for the organization to confirm
+   * @param id - Organization user identifier
+   * @param request - Request details for confirming the user
+   */
+  abstract postOrganizationUserConfirm(
+    organizationId: string,
+    id: string,
+    request: OrganizationUserConfirmRequest
+  ): Promise<void>;
+
+  /**
+   * Retrieve a list of the specified users' public keys
+   * @param organizationId - Identifier for the organization to accept
+   * @param ids - A list of organization user identifiers to retrieve public keys for
+   */
+  abstract postOrganizationUsersPublicKey(
+    organizationId: string,
+    ids: string[]
+  ): Promise<ListResponse<OrganizationUserBulkPublicKeyResponse>>;
+
+  /**
+   * Confirm many organization users that have accepted their invitations
+   * @param organizationId - Identifier for the organization to confirm users
+   * @param request - Bulk request details for confirming the user
+   */
+  abstract postOrganizationUserBulkConfirm(
+    organizationId: string,
+    request: OrganizationUserBulkConfirmRequest
+  ): Promise<ListResponse<OrganizationUserBulkResponse>>;
+
+  /**
+   * Update an organization users
+   * @param organizationId - Identifier for the organization the user belongs to
+   * @param id - Organization user identifier
+   * @param request - Request details for updating the user
+   */
+  abstract putOrganizationUser(
+    organizationId: string,
+    id: string,
+    request: OrganizationUserUpdateRequest
+  ): Promise<void>;
+
+  /**
+   * Update an organization user's groups
+   * @param organizationId - Identifier for the organization the user belongs to
+   * @param id - Organization user identifier
+   * @param groupIds - List of group ids to associate the user with
+   */
+  abstract putOrganizationUserGroups(
+    organizationId: string,
+    id: string,
+    groupIds: OrganizationUserUpdateGroupsRequest
+  ): Promise<void>;
+
+  /**
+   * Update an organization user's reset password enrollment
+   * @param organizationId - Identifier for the organization the user belongs to
+   * @param userId - Organization user identifier
+   * @param request - Reset password enrollment details
+   */
+  abstract putOrganizationUserResetPasswordEnrollment(
+    organizationId: string,
+    userId: string,
+    request: OrganizationUserResetPasswordEnrollmentRequest
+  ): Promise<void>;
+
+  /**
+   * Reset an organization user's password
+   * @param organizationId - Identifier for the organization the user belongs to
+   * @param id - Organization user identifier
+   * @param request - Reset password details
+   */
+  abstract putOrganizationUserResetPassword(
+    organizationId: string,
+    id: string,
+    request: OrganizationUserResetPasswordRequest
+  ): Promise<void>;
+
+  /**
+   * Delete an organization user
+   * @param organizationId - Identifier for the organization the user belongs to
+   * @param id - Organization user identifier
+   */
+  abstract deleteOrganizationUser(organizationId: string, id: string): Promise<void>;
+
+  /**
+   * Delete many organization users
+   * @param organizationId - Identifier for the organization the users belongs to
+   * @param ids - List of organization user identifiers to delete
+   * @return List of user ids, including both those that were successfully deleted and those that had an error
+   */
+  abstract deleteManyOrganizationUsers(
+    organizationId: string,
+    ids: string[]
+  ): Promise<ListResponse<OrganizationUserBulkResponse>>;
+
+  /**
+   * Revoke an organization user's access to the organization
+   * @param organizationId - Identifier for the organization the user belongs to
+   * @param id - Organization user identifier
+   */
+  abstract revokeOrganizationUser(organizationId: string, id: string): Promise<void>;
+
+  /**
+   * Revoke many organization users' access to the organization
+   * @param organizationId - Identifier for the organization the users belongs to
+   * @param ids - List of organization user identifiers to revoke
+   * @return List of user ids, including both those that were successfully revoked and those that had an error
+   */
+  abstract revokeManyOrganizationUsers(
+    organizationId: string,
+    ids: string[]
+  ): Promise<ListResponse<OrganizationUserBulkResponse>>;
+
+  /**
+   * Restore an organization user's access to the organization
+   * @param organizationId - Identifier for the organization the user belongs to
+   * @param id - Organization user identifier
+   */
+  abstract restoreOrganizationUser(organizationId: string, id: string): Promise<void>;
+
+  /**
+   * Restore many organization users' access to the organization
+   * @param organizationId - Identifier for the organization the users belongs to
+   * @param ids - List of organization user identifiers to restore
+   * @return List of user ids, including both those that were successfully restored and those that had an error
+   */
+  abstract restoreManyOrganizationUsers(
+    organizationId: string,
+    ids: string[]
+  ): Promise<ListResponse<OrganizationUserBulkResponse>>;
+}

libs/common/src/abstractions/organization-user/requests/index.ts

@@ -0,0 +1,8 @@
+export * from "./organization-user-accept.request";
+export * from "./organization-user-bulk-confirm.request";
+export * from "./organization-user-confirm.request";
+export * from "./organization-user-invite.request";
+export * from "./organization-user-reset-password.request";
+export * from "./organization-user-reset-password-enrollment.request";
+export * from "./organization-user-update.request";
+export * from "./organization-user-update-groups.request";

libs/common/src/abstractions/organization-user/requests/organization-user-accept.request.ts

@@ -0,0 +1,5 @@
+export class OrganizationUserAcceptRequest {
+  token: string;
+  // Used to auto-enroll in master password reset
+  resetPasswordKey: string;
+}

libs/common/src/abstractions/organization-user/requests/organization-user-bulk-confirm.request.ts

@@ -0,0 +1,12 @@
+type OrganizationUserBulkRequestEntry = {
+  id: string;
+  key: string;
+};
+
+export class OrganizationUserBulkConfirmRequest {
+  keys: OrganizationUserBulkRequestEntry[];
+
+  constructor(keys: OrganizationUserBulkRequestEntry[]) {
+    this.keys = keys;
+  }
+}

libs/common/src/abstractions/organization-user/requests/organization-user-confirm.request.ts

@@ -0,0 +1,3 @@
+export class OrganizationUserConfirmRequest {
+  key: string;
+}

libs/common/src/abstractions/organization-user/requests/organization-user-invite.request.ts

@@ -0,0 +1,11 @@
+import { OrganizationUserType } from "../../../enums/organizationUserType";
+import { PermissionsApi } from "../../../models/api/permissions.api";
+import { SelectionReadOnlyRequest } from "../../../models/request/selection-read-only.request";
+
+export class OrganizationUserInviteRequest {
+  emails: string[] = [];
+  type: OrganizationUserType;
+  accessAll: boolean;
+  collections: SelectionReadOnlyRequest[] = [];
+  permissions: PermissionsApi;
+}

libs/common/src/abstractions/organization-user/requests/organization-user-reset-password-enrollment.request.ts

@@ -0,0 +1,5 @@
+import { SecretVerificationRequest } from "../../../models/request/secret-verification.request";
+
+export class OrganizationUserResetPasswordEnrollmentRequest extends SecretVerificationRequest {
+  resetPasswordKey: string;
+}

libs/common/src/abstractions/organization-user/requests/organization-user-reset-password.request.ts

@@ -0,0 +1,4 @@
+export class OrganizationUserResetPasswordRequest {
+  newMasterPasswordHash: string;
+  key: string;
+}

libs/common/src/abstractions/organization-user/requests/organization-user-update-groups.request.ts

@@ -0,0 +1,3 @@
+export class OrganizationUserUpdateGroupsRequest {
+  groupIds: string[] = [];
+}

libs/common/src/abstractions/organization-user/requests/organization-user-update.request.ts

@@ -0,0 +1,10 @@
+import { OrganizationUserType } from "../../../enums/organizationUserType";
+import { PermissionsApi } from "../../../models/api/permissions.api";
+import { SelectionReadOnlyRequest } from "../../../models/request/selection-read-only.request";
+
+export class OrganizationUserUpdateRequest {
+  type: OrganizationUserType;
+  accessAll: boolean;
+  collections: SelectionReadOnlyRequest[] = [];
+  permissions: PermissionsApi;
+}

libs/common/src/abstractions/organization-user/responses/index.ts

@@ -0,0 +1,3 @@
+export * from "./organization-user.response";
+export * from "./organization-user-bulk.response";
+export * from "./organization-user-bulk-public-key.response";

libs/common/src/abstractions/organization-user/responses/organization-user-bulk-public-key.response.ts

@@ -0,0 +1,14 @@
+import { BaseResponse } from "../../../models/response/base.response";
+
+export class OrganizationUserBulkPublicKeyResponse extends BaseResponse {
+  id: string;
+  userId: string;
+  key: string;
+
+  constructor(response: any) {
+    super(response);
+    this.id = this.getResponseProperty("Id");
+    this.userId = this.getResponseProperty("UserId");
+    this.key = this.getResponseProperty("Key");
+  }
+}

libs/common/src/abstractions/organization-user/responses/organization-user-bulk.response.ts

@@ -0,0 +1,12 @@
+import { BaseResponse } from "../../../models/response/base.response";
+
+export class OrganizationUserBulkResponse extends BaseResponse {
+  id: string;
+  error: string;
+
+  constructor(response: any) {
+    super(response);
+    this.id = this.getResponseProperty("Id");
+    this.error = this.getResponseProperty("Error");
+  }
+}

libs/common/src/abstractions/organization-user/responses/organization-user.response.ts

@@ -0,0 +1,69 @@
+import { KdfType } from "../../../enums/kdfType";
+import { OrganizationUserStatusType } from "../../../enums/organizationUserStatusType";
+import { OrganizationUserType } from "../../../enums/organizationUserType";
+import { PermissionsApi } from "../../../models/api/permissions.api";
+import { BaseResponse } from "../../../models/response/base.response";
+import { SelectionReadOnlyResponse } from "../../../models/response/selection-read-only.response";
+
+export class OrganizationUserResponse extends BaseResponse {
+  id: string;
+  userId: string;
+  type: OrganizationUserType;
+  status: OrganizationUserStatusType;
+  accessAll: boolean;
+  permissions: PermissionsApi;
+  resetPasswordEnrolled: boolean;
+
+  constructor(response: any) {
+    super(response);
+    this.id = this.getResponseProperty("Id");
+    this.userId = this.getResponseProperty("UserId");
+    this.type = this.getResponseProperty("Type");
+    this.status = this.getResponseProperty("Status");
+    this.permissions = new PermissionsApi(this.getResponseProperty("Permissions"));
+    this.accessAll = this.getResponseProperty("AccessAll");
+    this.resetPasswordEnrolled = this.getResponseProperty("ResetPasswordEnrolled");
+  }
+}
+
+export class OrganizationUserUserDetailsResponse extends OrganizationUserResponse {
+  name: string;
+  email: string;
+  twoFactorEnabled: boolean;
+  usesKeyConnector: boolean;
+
+  constructor(response: any) {
+    super(response);
+    this.name = this.getResponseProperty("Name");
+    this.email = this.getResponseProperty("Email");
+    this.twoFactorEnabled = this.getResponseProperty("TwoFactorEnabled");
+    this.usesKeyConnector = this.getResponseProperty("UsesKeyConnector") ?? false;
+  }
+}
+
+export class OrganizationUserDetailsResponse extends OrganizationUserResponse {
+  collections: SelectionReadOnlyResponse[] = [];
+
+  constructor(response: any) {
+    super(response);
+    const collections = this.getResponseProperty("Collections");
+    if (collections != null) {
+      this.collections = collections.map((c: any) => new SelectionReadOnlyResponse(c));
+    }
+  }
+}
+
+export class OrganizationUserResetPasswordDetailsReponse extends BaseResponse {
+  kdf: KdfType;
+  kdfIterations: number;
+  resetPasswordKey: string;
+  encryptedPrivateKey: string;
+
+  constructor(response: any) {
+    super(response);
+    this.kdf = this.getResponseProperty("Kdf");
+    this.kdfIterations = this.getResponseProperty("KdfIterations");
+    this.resetPasswordKey = this.getResponseProperty("ResetPasswordKey");
+    this.encryptedPrivateKey = this.getResponseProperty("EncryptedPrivateKey");
+  }
+}