@frontegg/rest-api 6.0.1-alpha.4 → 7.28.0-alpha.0

package/node/constants.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.urls = void 0;
+exports.urls = exports.GENERIC_ERROR_MESSAGE = void 0;
 const urls = {
   vendor: '/vendors',
   identity: {
@@ -17,26 +17,71 @@ const urls = {
     users: {
       v1: '/identity/resources/users/v1',
       v2: '/identity/resources/users/v2',
+      v3: '/identity/resources/users/v3',
+      roles: {
+        v3: '/identity/resources/users/v3/roles'
+      },
+      groups: {
+        v3: '/identity/resources/users/v3/groups'
+      },
+      tenants: {
+        me: {
+          v1: '/identity/resources/users/v1/me/tenants',
+          v3: '/identity/resources/users/v3/me/tenants'
+        }
+      },
       apiTokens: {
         v1: '/identity/resources/users/api-tokens/v1'
       },
+      accessTokens: {
+        v1: '/identity/resources/users/access-tokens/v1'
+      },
       sessions: {
+        v1: '/identity/resources/users/sessions/v1',
         currentUser: {
           v1: '/identity/resources/users/sessions/v1/me'
+        },
+        configurations: {
+          v1: '/identity/resources/configurations/sessions/v1'
         }
       },
       invitation: {
         resendAll: {
           v1: '/identity/resources/users/v1/invitation/reset/all'
         }
+      },
+      passwords: {
+        resetBreachedPasswords: {
+          v1: '/identity/resources/users/v1/passwords/breached/reset/bulk'
+        }
+      },
+      authorization: {
+        v1: '/identity/resources/users/v1/me/authorization'
+      },
+      temporary: {
+        v1: '/identity/resources/users/temporary/v1',
+        configuration: {
+          v1: '/identity/resources/users/temporary/v1/configuration'
+        }
       }
     },
     configurations: {
       v1: '/identity/resources/configurations/v1'
     },
+    restrictions: {
+      emailDomain: {
+        v1: '/identity/resources/configurations/restrictions/v1/email-domain'
+      },
+      ip: {
+        v1: '/identity/resources/configurations/v1/restrictions/ip'
+      }
+    },
     sso: {
       v1: '/identity/resources/sso/v1',
-      v2: '/identity/resources/sso/v2'
+      v2: '/identity/resources/sso/v2',
+      custom: {
+        v1: '/identity/resources/sso/custom/v1'
+      }
     },
     permissions: {
       v1: '/identity/resources/permissions/v1'
@@ -46,6 +91,9 @@ const urls = {
         v1: '/identity/resources/tenants/api-tokens/v1',
         v2: '/identity/resources/tenants/api-tokens/v2'
       },
+      accessTokens: {
+        v1: '/identity/resources/tenants/access-tokens/v1'
+      },
       invites: {
         user: {
           v1: '/identity/resources/tenants/invites/v1/user'
@@ -56,13 +104,36 @@ const urls = {
         configuration: {
           v1: '/identity/resources/tenants/invites/v1/configuration'
         }
+      },
+      users: {
+        v1: '/identity/resources/tenants/users/v1'
       }
     },
     roles: {
-      v1: '/identity/resources/roles/v1'
+      v1: '/identity/resources/roles/v1',
+      v2: '/identity/resources/roles/v2'
     },
     subTenants: {
-      v1: '/identity/resources/sub-tenants/users/v1'
+      v1: '/identity/resources/sub-tenants/users/v1',
+      v2: '/identity/resources/sub-tenants/users/v2'
+    },
+    impersonate: {
+      v1: '/identity/resources/impersonation/v1'
+    },
+    applications: {
+      v1: '/identity/resources/applications/v1'
+    },
+    groups: {
+      v1: '/identity/resources/groups/v1',
+      configurations: {
+        v1: '/identity/resources/groups/v1/config'
+      },
+      getByIds: {
+        v1: '/identity/resources/groups/v1/bulkGet'
+      }
+    },
+    phoneNumbers: {
+      v1: '/identity/resources/users/phone-numbers/v1'
     }
   },
   team: {
@@ -80,9 +151,10 @@ const urls = {
       v1: '/team/resources/stats/v1'
     },
     profile: {
-      v1: '/team/resources/profile'
+      v1: '/team/resources/profile' // no versioning in backend
     }
   },
+
   tenants: {
     accountSettings: {
       v1: '/tenants/resources/account-settings/v1'
@@ -91,7 +163,17 @@ const urls = {
       v1: '/tenants/resources/hierarchy/v1',
       tree: {
         v1: '/tenants/resources/hierarchy/v1/tree'
+      },
+      parents: {
+        v1: '/tenants/resources/hierarchy/v1/parents'
+      },
+      v2: '/tenants/resources/hierarchy/v2',
+      metadata: {
+        v2: '/tenants/resources/hierarchy/v2/metadata'
       }
+    },
+    subTenants: {
+      v1: '/tenants/resources/sub-tenants/v1'
     }
   },
   integrations: {
@@ -120,6 +202,11 @@ const urls = {
       tenantConfiguration: {
         v1: '/subscriptions/resources/billing/tenant-configurations/v1'
       },
+      configurations: {
+        vendorPublicConfigurations: {
+          v1: '/subscriptions/resources/billing/configurations/vendor-public-configurations/v1'
+        }
+      },
       paymentProviders: {
         stripe: {
           customers: {
@@ -169,6 +256,37 @@ const urls = {
   },
   oauth: {
     v1: '/oauth'
+  },
+  featureFlags: {
+    v1: '/flags'
+  },
+  directory: {
+    v1: '/directory/resources/v1/configurations/scim2',
+    temp: '/directory/resources/scim/temp'
+  },
+  entitlements: {
+    v1: '/entitlements/api/v1/user-entitlements',
+    v2: '/entitlements/api/v2/user-entitlements'
+  },
+  securityCenter: {
+    recommendations: {
+      v1: '/security-center/resources/recommendations/v1'
+    },
+    insights: {
+      v1: '/security-center/resources/insights/v1'
+    }
+  },
+  applications: {
+    v1: '/applications/resources/applications/v1',
+    tenant: {
+      v1: '/applications/resources/applications/tenant-assignments/v1'
+    }
+  },
+  velo: {
+    // v1: '/nlp-execution-assistant/resources/velo/v1'
+    v1: 'http://localhost:3037/resources/velo/v1'
   }
 };
-exports.urls = urls;
+exports.urls = urls;
+const GENERIC_ERROR_MESSAGE = `We're facing some difficulties, Please try again`;
+exports.GENERIC_ERROR_MESSAGE = GENERIC_ERROR_MESSAGE;

package/node/directory/index.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.DirectoryApi = void 0;
+var _constants = require("../constants");
+var _BaseApiClient = require("../BaseApiClient");
+class DirectoryApi extends _BaseApiClient.BaseApiClient {
+  constructor(appName) {
+    super(appName);
+    this.getConfigs = async () => {
+      return this.get(`${_constants.urls.directory.v1}`);
+    };
+    this.updateConfiguration = async (id, body) => {
+      return this.patch(`${_constants.urls.directory.v1}/${id}`, body);
+    };
+    this.createConfiguration = async body => {
+      return this.post(`${_constants.urls.directory.v1}`, body);
+    };
+    this.deleteConfiguration = async id => {
+      return this.delete(`${_constants.urls.directory.v1}/${id}`);
+    };
+    this.countConfigurationUsers = async id => {
+      return this.get(`${_constants.urls.directory.temp}/${id}/Users/count`);
+    };
+  }
+
+  /**
+   * Returns all SCIM2 configurations
+   *
+   * ``authorized user``
+   */
+}
+exports.DirectoryApi = DirectoryApi;
+var _default = new DirectoryApi('default');
+exports.default = _default;

package/node/directory/interfaces.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ScimConnectionSource = void 0;
+let ScimConnectionSource;
+exports.ScimConnectionSource = ScimConnectionSource;
+(function (ScimConnectionSource) {
+  ScimConnectionSource["FRONTEGG"] = "frontegg";
+  ScimConnectionSource["OKTA"] = "okta";
+  ScimConnectionSource["AZURE_AD"] = "azure-ad";
+  ScimConnectionSource["OTHER"] = "other";
+})(ScimConnectionSource || (exports.ScimConnectionSource = ScimConnectionSource = {}));

package/node/entitlements/index.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.EntitlementsApi = void 0;
+var _constants = require("../constants");
+var _BaseApiClient = require("../BaseApiClient");
+class EntitlementsApi extends _BaseApiClient.BaseApiClient {
+  constructor(appName) {
+    super(appName);
+    this.loadEntitlementsV2 = async () => {
+      return this.get(_constants.urls.entitlements.v2);
+    };
+  }
+
+  /**
+   * Load user entitlements data v2.
+   * Including all user permissions and features data.
+   * Now the final isEntitled response is not part of it, but includes the data needed to calculate it.
+   *
+   * `authorized user`
+   */
+}
+exports.EntitlementsApi = EntitlementsApi;
+var _default = new EntitlementsApi('default');
+exports.default = _default;

package/node/entitlements/interfaces.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.NotEntitledJustification = exports.ADMIN_PORTAL_ENTITLEMENTS_FF = void 0;
+let NotEntitledJustification;
+/**
+ * entitlements feature flag
+ */
+exports.NotEntitledJustification = NotEntitledJustification;
+(function (NotEntitledJustification) {
+  NotEntitledJustification["MISSING_PERMISSION"] = "MISSING_PERMISSION";
+  NotEntitledJustification["MISSING_FEATURE"] = "MISSING_FEATURE";
+  NotEntitledJustification["BUNDLE_EXPIRED"] = "BUNDLE_EXPIRED";
+})(NotEntitledJustification || (exports.NotEntitledJustification = NotEntitledJustification = {}));
+const ADMIN_PORTAL_ENTITLEMENTS_FF = 'admin_portal_entitlements';
+exports.ADMIN_PORTAL_ENTITLEMENTS_FF = ADMIN_PORTAL_ENTITLEMENTS_FF;

package/node/error.js

@@ -4,18 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.FronteggApiError = void 0;
-
 class FronteggApiError extends Error {
   constructor(message, statusCode) {
     super(message);
     this._statusCode = void 0;
     this._statusCode = statusCode;
   }
-
   get statusCode() {
     return this._statusCode;
   }
-
 }
-
 exports.FronteggApiError = FronteggApiError;

package/node/feature-flags/index.js

@@ -0,0 +1,54 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.FeatureFlagsApi = exports.FeatureFlags = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _constants = require("../constants");
+var _BaseApiClient = require("../BaseApiClient");
+const defaultFeatureFlags = {
+  flags: {}
+};
+class FeatureFlags {
+  constructor() {
+    var _defaultFeatureFlags$;
+    this._flags = {};
+    this._flags = (_defaultFeatureFlags$ = defaultFeatureFlags.flags) != null ? _defaultFeatureFlags$ : {};
+  }
+  static getInstance(name = 'default') {
+    return this._instances[name];
+  }
+  static set(featureFlags, name = 'default') {
+    const featureFlagsInstance = new FeatureFlags();
+    featureFlagsInstance.set(featureFlags);
+    FeatureFlags._instances[name] = featureFlagsInstance;
+    return featureFlagsInstance;
+  }
+  static getFeatureFlags(flags, name) {
+    const featureFlagsInstance = this.getInstance(name);
+    return flags.map(flag => (featureFlagsInstance == null ? void 0 : featureFlagsInstance._flags[flag]) === 'on');
+  }
+  get flags() {
+    var _this$flags;
+    return (_this$flags = this.flags) != null ? _this$flags : {};
+  }
+  set(featureFlags) {
+    var _defaultFeatureFlags$2;
+    this._flags = (0, _extends2.default)({}, (_defaultFeatureFlags$2 = defaultFeatureFlags == null ? void 0 : defaultFeatureFlags.flags) != null ? _defaultFeatureFlags$2 : {}, featureFlags != null ? featureFlags : {});
+  }
+}
+exports.FeatureFlags = FeatureFlags;
+FeatureFlags._instances = {};
+class FeatureFlagsApi extends _BaseApiClient.BaseApiClient {
+  constructor(appName) {
+    super(appName);
+    this.loadFeatureFlags = async () => {
+      return this.get(_constants.urls.featureFlags.v1);
+    };
+  }
+}
+exports.FeatureFlagsApi = FeatureFlagsApi;
+var _default = new FeatureFlagsApi('default');
+exports.default = _default;

package/node/feature-flags/interfaces.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/node/groups/enums.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.GroupRelations = exports.GroupManagedByEnum = void 0;
+let GroupRelations;
+exports.GroupRelations = GroupRelations;
+(function (GroupRelations) {
+  GroupRelations["roles"] = "roles";
+  GroupRelations["users"] = "users";
+  GroupRelations["rolesAndUsers"] = "rolesAndUsers";
+})(GroupRelations || (exports.GroupRelations = GroupRelations = {}));
+let GroupManagedByEnum;
+exports.GroupManagedByEnum = GroupManagedByEnum;
+(function (GroupManagedByEnum) {
+  GroupManagedByEnum["FRONTEGG"] = "frontegg";
+  GroupManagedByEnum["SCIM2"] = "scim2";
+})(GroupManagedByEnum || (exports.GroupManagedByEnum = GroupManagedByEnum = {}));

package/node/groups/index.js

@@ -0,0 +1,70 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.GroupsApi = void 0;
+var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _constants = require("../constants");
+var _BaseApiClient = require("../BaseApiClient");
+const _excluded = ["groupId"];
+class GroupsApi extends _BaseApiClient.BaseApiClient {
+  constructor(appName) {
+    super(appName);
+    this.getGroupById = async ({
+      groupId
+    }, query) => {
+      return this.get(`${_constants.urls.identity.groups.v1}/${groupId}`, (0, _extends2.default)({}, query));
+    };
+    this.getGroups = async query => {
+      return this.get(`${_constants.urls.identity.groups.v1}`, (0, _extends2.default)({}, query));
+    };
+    this.getGroupsByIds = async (body, params) => {
+      return this.post(`${_constants.urls.identity.groups.getByIds.v1}`, body, {
+        params
+      });
+    };
+    this.createGroup = async body => {
+      return this.post(`${_constants.urls.identity.groups.v1}`, body);
+    };
+    this.updateGroup = async _ref => {
+      let {
+          groupId
+        } = _ref,
+        body = (0, _objectWithoutPropertiesLoose2.default)(_ref, _excluded);
+      return this.patch(`${_constants.urls.identity.groups.v1}/${groupId}`, body);
+    };
+    this.deleteGroup = async groupId => {
+      return this.delete(`${_constants.urls.identity.groups.v1}/${groupId}`);
+    };
+    this.addRolesToGroup = async (groupId, body) => {
+      return this.post(`${_constants.urls.identity.groups.v1}/${groupId}/roles`, body);
+    };
+    this.deleteRolesFromGroup = async (groupId, body) => {
+      return this.delete(`${_constants.urls.identity.groups.v1}/${groupId}/roles`, body);
+    };
+    this.addUsersToGroup = async (groupId, body) => {
+      return this.post(`${_constants.urls.identity.groups.v1}/${groupId}/users`, body);
+    };
+    this.deleteUsersFromGroup = async (groupId, body) => {
+      return this.delete(`${_constants.urls.identity.groups.v1}/${groupId}/users`, body);
+    };
+    this.getGroupConfiguration = async () => {
+      return this.get(`${_constants.urls.identity.groups.configurations.v1}`);
+    };
+    this.updateGroupConfiguration = async body => {
+      return this.post(`${_constants.urls.identity.groups.configurations.v1}`, body);
+    };
+  }
+
+  /**
+   * Get group by given id
+   * @param groupId - The ID of the group to retrieve
+   * @param query - Optional query parameters
+   */
+}
+exports.GroupsApi = GroupsApi;
+var _default = new GroupsApi('default');
+exports.default = _default;

package/node/groups/interfaces.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/node/impersonate/index.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.ImpersonateApi = void 0;
+var _constants = require("../constants");
+var _BaseApiClient = require("../BaseApiClient");
+/**
+ * UsersApi class provides methods for handling user and impersonation-related API requests.
+ */
+class ImpersonateApi extends _BaseApiClient.BaseApiClient {
+  constructor(appName) {
+    super(appName);
+    this.impersonate = async body => {
+      return this.post(`${_constants.urls.identity.impersonate.v1}`, body);
+    };
+  }
+
+  /**
+   * Impersonating user should be called after creating actor token that contains information about impersonation.
+   * `impersonate` should contain impersonated user info (userId, tenantId, and vendorId) and the actor token that was created for him to perform impersonation.
+   *
+   * @throws exception if impersonation failed
+   */
+}
+exports.ImpersonateApi = ImpersonateApi;
+var _default = new ImpersonateApi('default');
+exports.default = _default;

package/node/impersonate/interfaces.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});