@frontegg/rest-api 3.1.64 → 3.1.66

package/applications/index.d.ts

@@ -0,0 +1,46 @@
+import { IUserApplicationsIdPayload, IUserApplicationsDataPayload, IApplicationsResponse, IAssignUserToApplicationsBody, IUsersApplicationsIdPayload, IUsersOfApplicationsResponse, ITenantApplicationsResponse, IGetUsersOfApplicationsQuery } from "./interfaces";
+/**
+ * Get applications id array for single user by user id
+ * @param userId - user id to find his applications id array
+ * @returns all app ids as string[]
+ */
+export declare function getUserApplicationsId({ userId }: IUserApplicationsIdPayload): Promise<string[]>;
+/**
+ * Get applications id array for multiple users by user id array
+ * @param userIds - array of all user id's
+ * @returns object that maps every user id to his applications id array
+ */
+export declare function getUsersApplicationsId({ userIds }: IUsersApplicationsIdPayload): Promise<Record<string, string[]>>;
+/**
+ * Get applications data array for specific tenant
+ * @returns array of object with tenant id and his applications id array
+ */
+export declare function getTenantsApplications(): Promise<ITenantApplicationsResponse[]>;
+/**
+ * Get applications data by array of application ids
+ * @param appIds - array of application ids
+ * @returns array of application data
+ */
+export declare function getApplicationsData({ appIds, includeFreeAccess }: IUserApplicationsDataPayload): Promise<IApplicationsResponse[]>;
+/**
+ * Assign user to multiple applications
+ * @param appIds - string[]
+ * @param tenantId - string
+ * @param userId - string
+ * @returns void
+ */
+export declare function assignUserToApplications(body: IAssignUserToApplicationsBody): Promise<void>;
+/**
+ * Unassign user from multiple applications
+ * @param appIds - string[]
+ * @param tenantId - string
+ * @param userId - string
+ * @returns void
+ */
+export declare function unassignUserFromApplications(body: IAssignUserToApplicationsBody): Promise<void>;
+/**
+ * Get users array for each application for array of applications
+ * @param appIds - array of applications
+ * @returns array of objects with application id and his users array
+ */
+export declare function getUsersOfApplications(query: IGetUsersOfApplicationsQuery): Promise<IUsersOfApplicationsResponse[]>;

package/applications/index.js

@@ -0,0 +1,35 @@
+import { urls } from "../constants";
+import { Post, Get, Delete } from "../fetch";
+export async function getUserApplicationsId({
+  userId
+}) {
+  return Get(`${urls.identity.applications.v1}/${userId}/apps`);
+}
+export async function getUsersApplicationsId({
+  userIds
+}) {
+  return Get(`${urls.identity.applications.v1}/users-apps`, {
+    userIds: userIds.join(',')
+  });
+}
+export async function getTenantsApplications() {
+  return Get(urls.applications.tenant.v1);
+}
+export async function getApplicationsData({
+  appIds,
+  includeFreeAccess = true
+}) {
+  return Get(urls.applications.v1, {
+    ids: appIds.join(','),
+    _includeFreeAccess: includeFreeAccess
+  });
+}
+export async function assignUserToApplications(body) {
+  return Post(`${urls.identity.applications.v1}/user-apps`, body);
+}
+export async function unassignUserFromApplications(body) {
+  return Delete(`${urls.identity.applications.v1}/user-apps`, body);
+}
+export async function getUsersOfApplications(query) {
+  return Get(`${urls.identity.applications.v1}/apps-users`, query);
+}

package/applications/interfaces.d.ts

@@ -0,0 +1,45 @@
+export declare type IUserApplicationsIdPayload = {
+    userId: string;
+};
+export declare type IUsersApplicationsIdPayload = {
+    userIds: string[];
+};
+export declare type IGetUsersOfApplicationsQuery = {
+    appIds: string[];
+};
+export declare type IUserApplicationsDataPayload = IGetUsersOfApplicationsQuery & {
+    includeFreeAccess?: boolean;
+};
+export declare type IUsersOfApplicationsResponse = {
+    appId: string;
+    userIds: string[];
+};
+export declare type IAssignUserToApplicationsBody = {
+    userId: string;
+    tenantId: string;
+    appIds: string[];
+};
+export declare enum ApplicationAccessType {
+    FREE_ACCESS = "FREE_ACCESS",
+    MANAGED_ACCESS = "MANAGED_ACCESS"
+}
+export declare type IApplicationsResponse = {
+    id: string;
+    accessType: ApplicationAccessType;
+    appURL: string;
+    loginURL: string;
+    isDefault: boolean;
+    isActive: boolean;
+    name: string;
+    logoURL: string;
+    createdAt: string;
+    updatedAt: string;
+    type: string;
+    frontendStack: string;
+    description: string;
+    integrationFinishedAt: string;
+};
+export declare type ITenantApplicationsResponse = {
+    tenantId: string;
+    appIds?: string[];
+};

package/applications/interfaces.js

@@ -0,0 +1,6 @@
+export let ApplicationAccessType;
+
+(function (ApplicationAccessType) {
+  ApplicationAccessType["FREE_ACCESS"] = "FREE_ACCESS";
+  ApplicationAccessType["MANAGED_ACCESS"] = "MANAGED_ACCESS";
+})(ApplicationAccessType || (ApplicationAccessType = {}));

package/applications/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../node/applications/index.js",
+  "types": "./index.d.ts"
+}

package/constants.d.ts

@@ -114,6 +114,9 @@ export declare const urls: {
         impersonate: {
             v1: string;
         };
+        applications: {
+            v1: string;
+        };
         groups: {
             v1: string;
             configurations: {
@@ -266,5 +269,11 @@ export declare const urls: {
             v1: string;
         };
     };
+    applications: {
+        v1: string;
+        tenant: {
+            v1: string;
+        };
+    };
 };
 export declare const GENERIC_ERROR_MESSAGE = "We're facing some difficulties, Please try again";

package/constants.js

@@ -114,6 +114,9 @@ export const urls = {
     impersonate: {
       v1: '/identity/resources/impersonation/v1'
     },
+    applications: {
+      v1: '/identity/resources/applications/v1'
+    },
     groups: {
       v1: '/identity/resources/groups/v1',
       configurations: {
@@ -265,6 +268,12 @@ export const urls = {
     insights: {
       v1: '/security-center/resources/insights/v1'
     }
+  },
+  applications: {
+    v1: '/applications/resources/applications/v1',
+    tenant: {
+      v1: '/applications/resources/applications/tenant-assignments/v1'
+    }
   }
 };
 export const GENERIC_ERROR_MESSAGE = `We're facing some difficulties, Please try again`;

package/fetch.js

@@ -146,6 +146,13 @@ async function getAdditionalHeaders(context) {
     }
   }
 
+  if (context.appId) {
+    output.push({
+      key: 'frontegg-requested-application-id',
+      value: context.appId
+    });
+  }
+
   return output;
 }
 

package/index.d.ts

@@ -11,6 +11,7 @@ import * as tenants from "./tenants";
 import * as accountSettings from "./account-settings";
 import * as roles from "./roles";
 import * as subscriptions from "./subscriptions";
+import * as applications from "./applications";
 import { ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType } from "./subscriptions";
 import { FronteggApiError } from "./error";
 import * as vendor from "./vendor";
@@ -51,6 +52,7 @@ export * from "./users/interfaces";
 export * from "./entitlements/interfaces";
 export * from "./security-center/interfaces";
 export * from "./user-phone-numbers/interfaces";
+export * from "./applications/interfaces";
 declare const api: {
     auth: typeof auth;
     teams: typeof teams;
@@ -73,6 +75,7 @@ declare const api: {
     entitlements: typeof entitlements;
     securityCenter: typeof securityCenter;
     userPhoneNumbers: typeof userPhoneNumbers;
+    applications: typeof applications;
 };
 export { fetch, ContextHolder, FronteggContext, api, FronteggApiError, AuthStrategyEnum, SocialLoginProviders, ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType, MachineToMachineAuthStrategy, };
 declare const _default: {
@@ -107,6 +110,7 @@ declare const _default: {
         entitlements: typeof entitlements;
         securityCenter: typeof securityCenter;
         userPhoneNumbers: typeof userPhoneNumbers;
+        applications: typeof applications;
     };
     FronteggApiError: typeof FronteggApiError;
     AuthStrategyEnum: typeof auth.AuthStrategyEnum;

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.1.64
+/** @license Frontegg v3.1.66
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -16,6 +16,7 @@ import * as tenants from "./tenants";
 import * as accountSettings from "./account-settings";
 import * as roles from "./roles";
 import * as subscriptions from "./subscriptions";
+import * as applications from "./applications";
 import { ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType } from "./subscriptions";
 import { FronteggApiError } from "./error";
 import * as vendor from "./vendor";
@@ -56,6 +57,7 @@ export * from "./users/interfaces";
 export * from "./entitlements/interfaces";
 export * from "./security-center/interfaces";
 export * from "./user-phone-numbers/interfaces";
+export * from "./applications/interfaces";
 const api = {
   auth,
   teams,
@@ -77,7 +79,8 @@ const api = {
   users,
   entitlements,
   securityCenter,
-  userPhoneNumbers
+  userPhoneNumbers,
+  applications
 };
 export { fetch, ContextHolder, FronteggContext, api, FronteggApiError, AuthStrategyEnum, SocialLoginProviders, ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType, MachineToMachineAuthStrategy };
 export default {

package/interfaces.d.ts

@@ -61,6 +61,10 @@ export interface SessionContext {
 export interface ContextOptions {
     baseUrl: string | ((url: string) => string);
     clientId?: string;
+    /**
+     * Will be used to identify the application, use only for multi applications
+     */
+    appId?: string;
     tokenResolver?: () => Promise<string> | string;
     /**
      * custom login header value

package/node/applications/index.js

@@ -0,0 +1,56 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.assignUserToApplications = assignUserToApplications;
+exports.getApplicationsData = getApplicationsData;
+exports.getTenantsApplications = getTenantsApplications;
+exports.getUserApplicationsId = getUserApplicationsId;
+exports.getUsersApplicationsId = getUsersApplicationsId;
+exports.getUsersOfApplications = getUsersOfApplications;
+exports.unassignUserFromApplications = unassignUserFromApplications;
+
+var _constants = require("../constants");
+
+var _fetch = require("../fetch");
+
+async function getUserApplicationsId({
+  userId
+}) {
+  return (0, _fetch.Get)(`${_constants.urls.identity.applications.v1}/${userId}/apps`);
+}
+
+async function getUsersApplicationsId({
+  userIds
+}) {
+  return (0, _fetch.Get)(`${_constants.urls.identity.applications.v1}/users-apps`, {
+    userIds: userIds.join(',')
+  });
+}
+
+async function getTenantsApplications() {
+  return (0, _fetch.Get)(_constants.urls.applications.tenant.v1);
+}
+
+async function getApplicationsData({
+  appIds,
+  includeFreeAccess = true
+}) {
+  return (0, _fetch.Get)(_constants.urls.applications.v1, {
+    ids: appIds.join(','),
+    _includeFreeAccess: includeFreeAccess
+  });
+}
+
+async function assignUserToApplications(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.applications.v1}/user-apps`, body);
+}
+
+async function unassignUserFromApplications(body) {
+  return (0, _fetch.Delete)(`${_constants.urls.identity.applications.v1}/user-apps`, body);
+}
+
+async function getUsersOfApplications(query) {
+  return (0, _fetch.Get)(`${_constants.urls.identity.applications.v1}/apps-users`, query);
+}

package/node/applications/interfaces.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ApplicationAccessType = void 0;
+let ApplicationAccessType;
+exports.ApplicationAccessType = ApplicationAccessType;
+
+(function (ApplicationAccessType) {
+  ApplicationAccessType["FREE_ACCESS"] = "FREE_ACCESS";
+  ApplicationAccessType["MANAGED_ACCESS"] = "MANAGED_ACCESS";
+})(ApplicationAccessType || (exports.ApplicationAccessType = ApplicationAccessType = {}));

package/node/constants.js

@@ -120,6 +120,9 @@ const urls = {
     impersonate: {
       v1: '/identity/resources/impersonation/v1'
     },
+    applications: {
+      v1: '/identity/resources/applications/v1'
+    },
     groups: {
       v1: '/identity/resources/groups/v1',
       configurations: {
@@ -271,6 +274,12 @@ const urls = {
     insights: {
       v1: '/security-center/resources/insights/v1'
     }
+  },
+  applications: {
+    v1: '/applications/resources/applications/v1',
+    tenant: {
+      v1: '/applications/resources/applications/tenant-assignments/v1'
+    }
   }
 };
 exports.urls = urls;

package/node/fetch.js

@@ -166,6 +166,13 @@ async function getAdditionalHeaders(context) {
     }
   }
 
+  if (context.appId) {
+    output.push({
+      key: 'frontegg-requested-application-id',
+      value: context.appId
+    });
+  }
+
   return output;
 }
 

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.1.64
+/** @license Frontegg v3.1.66
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -131,6 +131,8 @@ var roles = _interopRequireWildcard(require("./roles"));
 
 var subscriptions = _interopRequireWildcard(require("./subscriptions"));
 
+var applications = _interopRequireWildcard(require("./applications"));
+
 var _error = require("./error");
 
 var vendor = _interopRequireWildcard(require("./vendor"));
@@ -519,6 +521,20 @@ Object.keys(_interfaces22).forEach(function (key) {
   });
 });
 
+var _interfaces23 = require("./applications/interfaces");
+
+Object.keys(_interfaces23).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _interfaces23[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _interfaces23[key];
+    }
+  });
+});
+
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -544,7 +560,8 @@ const api = {
   users,
   entitlements,
   securityCenter,
-  userPhoneNumbers
+  userPhoneNumbers,
+  applications
 };
 exports.api = api;
 var _default = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontegg/rest-api",
-  "version": "3.1.64",
+  "version": "3.1.66",
   "main": "./node/index.js",
   "license": "MIT",
   "dependencies": {