@frontegg/rest-api 3.0.74 → 3.0.76

package/auth/index.d.ts

@@ -1,7 +1,7 @@
 export * from "./secutiry-poilicy";
 export * from "./enums";
 import { ISamlRolesGroup } from "../teams/interfaces";
-import { IAcceptInvitation, IActivateAccount, IAllowedToRememberMfaDevice, ICreateSamlGroup, IDeleteApiToken, IDisableMfa, IEnrollMfaResponse, IForgotPassword, IGetActivateAccountStrategy, IGetActivateAccountStrategyResponse, IGetUserById, IGetUserPasswordConfig, ILogin, ILoginResponse, ILoginViaSocialLogin, ILoginViaSocialLoginResponse, ILoginWithMfa, IOidcPostLogin, IOidcConfiguration, IPostLogin, IPreLogin, IRecoverMFAToken, IResendActivationEmail, IResetPassword, ISamlConfiguration, ISamlVendorConfigResponse, ISignUpResponse, ISignUpUser, ISocialLoginProviderConfiguration, ITenantApiTokensData, IUpdateSamlConfiguration, IUpdateSamlGroup, IUpdateSamlRoles, IUpdateSamlVendorMetadata, IUpdateTenantApiTokensData, IUpdateUserApiTokensData, IUserApiTokensData, IUserIdResponse, IVendorConfig, IVerifyMfa, IVerifyMfaResponse, TestConfig, ISSOPublicConfiguration, IPreLoginWithIdpTypeResponse, IPasswordlessPreLogin, IPasswordlessPostLogin, ICreateSSODomain, IVerifyInviteToken, ISSODomain, ISSOConfigurationDefaultRoles, ISSOConfiguration, IUpdateSSOConfiguration, IOidcPostLoginV2, IExchangeOAuthTokens, IOAuthTokenResponse, ISocialLoginProviderConfigurationV2, ILoginResponseV2, IResetPhoneNumber, IVerifyResetPhoneNumber, IChangePhoneNumber, IVerifyResetPhoneNumberResponse, IResetPhoneNumberResponse, IWebAuthnPreLogin, IWebAuthnPostLogin, IVerifyNewWebAuthnDevice, IWebAuthnPreLoginResponse, ICreateNewDeviceSessionResponse, IAuthStrategiesConfig, ISessionResponse, IChangePhoneNumberWithVerification, IChangePhoneNumberWithVerificationResponse, IVerifyChangePhoneNumber, ISessionConfigurations, IResendInvitationEmail, IPreEnrollMFA, IEnrollMFAAuthenticatorApp, IPreEnrollMFASMS, IEnrollMFASMS, IEnrollMFAWebAuthn, IPreEnrollMFAAuthenticatorAppResponse, IPreEnrollMFAWebAuthnResponse, IVerifyMFAAuthenticatorApp, IPreVerifyMFA, IPreVerifyMFASMSResponse, IVerifyMFASMS, IPreVerifyMFAWebAuthnResponse, IVerifyMFAWebAuthn, IPreEnrollMFASMSResponse, IPreDisableMFASMSResponse, IDisableMFASMS, IDisableMFAWebAuthn, IPreDisableMFAWebAuthnResponse, UserMFADevicesResponse, WithoutMFAToken, IMFAStrategiesResponse, IOAuthLogout, IGetUserAccessTokens, IGetTenantAccessTokens, IDeleteAccessToken, ICreateTenantAccessTokenData, ICreateUserAccessTokenData } from "./interfaces";
+import { IAcceptInvitation, IActivateAccount, IAllowedToRememberMfaDevice, ICreateSamlGroup, IDeleteApiToken, IDisableMfa, IEnrollMfaResponse, IForgotPassword, IGetActivateAccountStrategy, IGetActivateAccountStrategyResponse, IGetUserById, IGetUserPasswordConfig, ILogin, ILoginResponse, ILoginViaSocialLogin, ILoginViaSocialLoginResponse, ILoginWithMfa, IOidcPostLogin, IOidcConfiguration, IPostLogin, IPreLogin, IRecoverMFAToken, IResendActivationEmail, IResetPassword, ISamlConfiguration, ISamlVendorConfigResponse, ISignUpResponse, ISignUpUser, ISocialLoginProviderConfiguration, ITenantApiTokensData, IUpdateSamlConfiguration, IUpdateSamlGroup, IUpdateSamlRoles, IUpdateSamlVendorMetadata, IUpdateTenantApiTokensData, IUpdateUserApiTokensData, IUserApiTokensData, IUserIdResponse, IVendorConfig, IVerifyMfa, IVerifyMfaResponse, TestConfig, ISSOPublicConfiguration, IPreLoginWithIdpTypeResponse, IPasswordlessPreLogin, IPasswordlessPostLogin, ICreateSSODomain, IVerifyInviteToken, ISSODomain, ISSOConfigurationDefaultRoles, ISSOConfiguration, IUpdateSSOConfiguration, IOidcPostLoginV2, IExchangeOAuthTokens, IOAuthTokenResponse, ISocialLoginProviderConfigurationV2, ILoginResponseV2, IResetPhoneNumber, IVerifyResetPhoneNumber, IChangePhoneNumber, IVerifyResetPhoneNumberResponse, IResetPhoneNumberResponse, IWebAuthnPreLogin, IWebAuthnPostLogin, IVerifyNewWebAuthnDevice, IWebAuthnPreLoginResponse, ICreateNewDeviceSessionResponse, IAuthStrategiesConfig, ISessionResponse, IChangePhoneNumberWithVerification, IChangePhoneNumberWithVerificationResponse, IVerifyChangePhoneNumber, ISessionConfigurations, IResendInvitationEmail, IPreEnrollMFA, IEnrollMFAAuthenticatorApp, IPreEnrollMFASMS, IEnrollMFASMS, IEnrollMFAWebAuthn, IPreEnrollMFAAuthenticatorAppResponse, IPreEnrollMFAWebAuthnResponse, IVerifyMFAAuthenticatorApp, IPreVerifyMFA, IPreVerifyMFASMSResponse, IVerifyMFASMS, IPreVerifyMFAWebAuthnResponse, IVerifyMFAWebAuthn, IPreEnrollMFASMSResponse, IPreDisableMFASMSResponse, IDisableMFASMS, IDisableMFAWebAuthn, IPreDisableMFAWebAuthnResponse, UserMFADevicesResponse, WithoutMFAToken, IMFAStrategiesResponse, IOAuthLogout, IGetUserAccessTokens, IGetTenantAccessTokens, IDeleteAccessToken, ICreateTenantAccessTokenData, ICreateUserAccessTokenData, IWebAuthnDevices } from "./interfaces";
 /*****************************************
  * Authentication
  *****************************************/
@@ -615,6 +615,10 @@ export declare function webAuthnPostLogin(body: IWebAuthnPostLogin): Promise<ILo
  * webauthn create new device should be called once the user wants to add new device as authenticator
  */
 export declare function webAuthnCreateNewDeviceSession(): Promise<ICreateNewDeviceSessionResponse>;
+/**
+ * get webauthn devices should be called in order to get user's webAuthn devices
+ */
+export declare function getWebAuthnDevices(): Promise<IWebAuthnDevices>;
 /**
  * webauthn verify new device should be called after the user used his authenticator in order to register the new device
  */

package/auth/index.js

@@ -518,6 +518,9 @@ export async function webAuthnPostLogin(body) {
 export async function webAuthnCreateNewDeviceSession() {
   return Post(urls.identity.webAuthnDevices.v1);
 }
+export async function getWebAuthnDevices() {
+  return Get(urls.identity.webAuthnDevices.v1);
+}
 export async function verifyNewDeviceSession(body) {
   return Post(`${urls.identity.webAuthnDevices.v1}/verify`, body);
 }

package/auth/interfaces.d.ts

@@ -482,7 +482,8 @@ export interface IVerifyNewWebAuthnDevice {
 export declare enum SecondaryAuthStrategy {
     WebAuthnPlatform = "WebAuthnPlatform",
     WebAuthnCrossPlatform = "WebAuthnCrossPlatform",
-    SmsCode = "SmsCode"
+    SmsCode = "SmsCode",
+    Passkeys = "Passkeys"
 }
 export interface IAuthStrategyConfig {
     strategy: SecondaryAuthStrategy;
@@ -519,6 +520,14 @@ export declare enum WebAuthnDeviceType {
     Platform = "Platform",
     CrossPlatform = "CrossPlatform"
 }
+export interface IWebAuthnDevice {
+    id: string;
+    deviceType: WebAuthnDeviceType;
+    createdAt: Date;
+}
+export interface IWebAuthnDevices {
+    devices: IWebAuthnDevice[];
+}
 export interface IEnrollMFAWebAuthn extends IEnrollMFA {
     deviceType: WebAuthnDeviceType;
     webauthnToken: string;

package/auth/interfaces.js

@@ -5,6 +5,7 @@ export let SecondaryAuthStrategy;
   SecondaryAuthStrategy["WebAuthnPlatform"] = "WebAuthnPlatform";
   SecondaryAuthStrategy["WebAuthnCrossPlatform"] = "WebAuthnCrossPlatform";
   SecondaryAuthStrategy["SmsCode"] = "SmsCode";
+  SecondaryAuthStrategy["Passkeys"] = "Passkeys";
 })(SecondaryAuthStrategy || (SecondaryAuthStrategy = {}));
 
 export let WebAuthnDeviceType;

package/constants.d.ts

@@ -79,6 +79,18 @@ export declare const urls: {
         impersonate: {
             v1: string;
         };
+        groups: {
+            configurations: {
+                v1: string;
+            };
+            v1: string;
+            roles: {
+                v1: string;
+            };
+            users: {
+                v1: string;
+            };
+        };
     };
     team: {
         sso: {

package/constants.js

@@ -78,6 +78,18 @@ export const urls = {
     },
     impersonate: {
       v1: '/identity/resources/impersonation/v1'
+    },
+    groups: {
+      configurations: {
+        v1: '/identity/resources/groups/v1/config'
+      },
+      v1: '/identity/resources/groups/v1',
+      roles: {
+        v1: '/identity/resources/groups/v1/roles'
+      },
+      users: {
+        v1: '/identity/resources/groups/v1/users'
+      }
     }
   },
   team: {

package/groups/index.d.ts

@@ -0,0 +1,45 @@
+import { ICreateGroup, ICreateGroupResponse, IGetGroup, IGroupConfigResponse, IGroupResponse, IUpdateGroup, IUpdateGroupConfig, IUpdateGroupRoles, IUpdateGroupUsers } from "./interfaces";
+/**
+ * Get group by given id
+ */
+export declare function getGroupById({ groupId, }: IGetGroup): Promise<IGroupResponse>;
+/**
+ * Get all tenant groups
+ */
+export declare function getGroups(): Promise<IGroupResponse[]>;
+/**
+ * Create new group
+ */
+export declare function createGroup(body: ICreateGroup): Promise<ICreateGroupResponse>;
+/**
+ * Update existing group by Id
+ */
+export declare function updateGroup({ groupId, ...body }: IUpdateGroup): Promise<void>;
+/**
+ * Delete existing group by Id
+ */
+export declare function deleteGroup(groupId: string): Promise<void>;
+/**
+ * Add roles to existing group
+ */
+export declare function addRolesToGroup(body: IUpdateGroupRoles): Promise<void>;
+/**
+ * Delete roles from existing group
+ */
+export declare function deleteRolesFromGroup(body: IUpdateGroupRoles): Promise<void>;
+/**
+ * Add users to existing group
+ */
+export declare function addUsersToGroup(body: IUpdateGroupUsers): Promise<void>;
+/**
+ * Delete users from existing group
+ */
+export declare function deleteUsersFromGroup(body: IUpdateGroupUsers): Promise<void>;
+/**
+ * Get or create default groups configuration
+ */
+export declare function getGroupConfiguration(): Promise<IGroupConfigResponse>;
+/**
+ * Create or update groups configuration
+ */
+export declare function updateGroupConfiguration(body: IUpdateGroupConfig): Promise<IGroupConfigResponse>;

package/groups/index.js

@@ -0,0 +1,44 @@
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["groupId"];
+import { urls } from "../constants";
+import { Delete, Get, Patch, Post } from "../fetch";
+export async function getGroupById({
+  groupId
+}) {
+  return Get(`${urls.identity.groups.v1}/${groupId}`);
+}
+export async function getGroups() {
+  return Get(`${urls.identity.groups.v1}`);
+}
+export async function createGroup(body) {
+  return Post(`${urls.identity.groups.v1}`, body);
+}
+export async function updateGroup(_ref) {
+  let {
+    groupId
+  } = _ref,
+      body = _objectWithoutPropertiesLoose(_ref, _excluded);
+
+  return Patch(`${urls.identity.groups.v1}/${groupId}`, body);
+}
+export async function deleteGroup(groupId) {
+  return Delete(`${urls.identity.groups.v1}/${groupId}`);
+}
+export async function addRolesToGroup(body) {
+  return Post(`${urls.identity.groups.roles.v1}`, body);
+}
+export async function deleteRolesFromGroup(body) {
+  return Delete(`${urls.identity.groups.roles.v1}`, body);
+}
+export async function addUsersToGroup(body) {
+  return Post(`${urls.identity.groups.users.v1}`, body);
+}
+export async function deleteUsersFromGroup(body) {
+  return Delete(`${urls.identity.groups.users.v1}`, body);
+}
+export async function getGroupConfiguration() {
+  return Get(`${urls.identity.groups.configurations.v1}`);
+}
+export async function updateGroupConfiguration(body) {
+  return Post(`${urls.identity.groups.configurations.v1}`, body);
+}

package/groups/interfaces.d.ts

@@ -0,0 +1,59 @@
+import { IRole } from "../roles/interfaces";
+export declare type IGetGroup = {
+    groupId: string;
+};
+export declare type IGroupUser = {
+    id: string;
+    email: string;
+    name: string;
+    phoneNumber?: string;
+    profileImage?: string;
+    profilePictureUrl: string | null;
+    tenantId: string;
+    tenantIds: string[];
+    activatedForTenant?: boolean;
+};
+export declare type IGroupResponse = {
+    name: string;
+    color?: string;
+    description?: string;
+    metadata?: string;
+    roles?: IRole[];
+    users?: IGroupUser[];
+};
+export declare type ICreateGroup = {
+    name: string;
+    color?: string;
+    description?: string;
+    metadata?: string;
+};
+export declare type ICreateGroupResponse = {
+    id: string;
+    name: string;
+    color?: string;
+    description?: string;
+    metadata?: string;
+};
+export declare type IUpdateGroup = {
+    groupId: string;
+    name?: string;
+    color?: string;
+    description?: string;
+    metadata?: string;
+};
+export declare type IUpdateGroupConfig = {
+    enabled?: boolean;
+    rolesEnabled?: boolean;
+};
+export declare type IGroupConfigResponse = {
+    enabled: boolean;
+    rolesEnabled: boolean;
+};
+export declare type IUpdateGroupRoles = {
+    groupId: string;
+    roleIds: string[];
+};
+export declare type IUpdateGroupUsers = {
+    groupId: string;
+    userIds: string[];
+};

package/groups/interfaces.js

@@ -0,0 +1 @@
+export {};

package/groups/package.json

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

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.74
+/** @license Frontegg v3.0.76
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/node/auth/index.js

@@ -123,6 +123,7 @@ var _exportNames = {
   webAuthnPreLogin: true,
   webAuthnPostLogin: true,
   webAuthnCreateNewDeviceSession: true,
+  getWebAuthnDevices: true,
   verifyNewDeviceSession: true,
   getVendorPublicAuthStrategiesConfig: true,
   getMFAStrategiesConfig: true
@@ -191,6 +192,7 @@ exports.getUserApiTokensData = getUserApiTokensData;
 exports.getUserById = getUserById;
 exports.getVendorConfig = getVendorConfig;
 exports.getVendorPublicAuthStrategiesConfig = getVendorPublicAuthStrategiesConfig;
+exports.getWebAuthnDevices = getWebAuthnDevices;
 exports.loadPasswordConfig = loadPasswordConfig;
 exports.login = login;
 exports.loginViaSocialLogin = loginViaSocialLogin;
@@ -920,6 +922,10 @@ async function webAuthnCreateNewDeviceSession() {
   return (0, _fetch.Post)(_constants.urls.identity.webAuthnDevices.v1);
 }
 
+async function getWebAuthnDevices() {
+  return (0, _fetch.Get)(_constants.urls.identity.webAuthnDevices.v1);
+}
+
 async function verifyNewDeviceSession(body) {
   return (0, _fetch.Post)(`${_constants.urls.identity.webAuthnDevices.v1}/verify`, body);
 }

package/node/auth/interfaces.js

@@ -30,6 +30,7 @@ exports.SecondaryAuthStrategy = SecondaryAuthStrategy;
   SecondaryAuthStrategy["WebAuthnPlatform"] = "WebAuthnPlatform";
   SecondaryAuthStrategy["WebAuthnCrossPlatform"] = "WebAuthnCrossPlatform";
   SecondaryAuthStrategy["SmsCode"] = "SmsCode";
+  SecondaryAuthStrategy["Passkeys"] = "Passkeys";
 })(SecondaryAuthStrategy || (exports.SecondaryAuthStrategy = SecondaryAuthStrategy = {}));
 
 let WebAuthnDeviceType;

package/node/constants.js

@@ -84,6 +84,18 @@ const urls = {
     },
     impersonate: {
       v1: '/identity/resources/impersonation/v1'
+    },
+    groups: {
+      configurations: {
+        v1: '/identity/resources/groups/v1/config'
+      },
+      v1: '/identity/resources/groups/v1',
+      roles: {
+        v1: '/identity/resources/groups/v1/roles'
+      },
+      users: {
+        v1: '/identity/resources/groups/v1/users'
+      }
     }
   },
   team: {

package/node/groups/index.js

@@ -0,0 +1,76 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.addRolesToGroup = addRolesToGroup;
+exports.addUsersToGroup = addUsersToGroup;
+exports.createGroup = createGroup;
+exports.deleteGroup = deleteGroup;
+exports.deleteRolesFromGroup = deleteRolesFromGroup;
+exports.deleteUsersFromGroup = deleteUsersFromGroup;
+exports.getGroupById = getGroupById;
+exports.getGroupConfiguration = getGroupConfiguration;
+exports.getGroups = getGroups;
+exports.updateGroup = updateGroup;
+exports.updateGroupConfiguration = updateGroupConfiguration;
+
+var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
+
+var _constants = require("../constants");
+
+var _fetch = require("../fetch");
+
+const _excluded = ["groupId"];
+
+async function getGroupById({
+  groupId
+}) {
+  return (0, _fetch.Get)(`${_constants.urls.identity.groups.v1}/${groupId}`);
+}
+
+async function getGroups() {
+  return (0, _fetch.Get)(`${_constants.urls.identity.groups.v1}`);
+}
+
+async function createGroup(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.groups.v1}`, body);
+}
+
+async function updateGroup(_ref) {
+  let {
+    groupId
+  } = _ref,
+      body = (0, _objectWithoutPropertiesLoose2.default)(_ref, _excluded);
+  return (0, _fetch.Patch)(`${_constants.urls.identity.groups.v1}/${groupId}`, body);
+}
+
+async function deleteGroup(groupId) {
+  return (0, _fetch.Delete)(`${_constants.urls.identity.groups.v1}/${groupId}`);
+}
+
+async function addRolesToGroup(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.groups.roles.v1}`, body);
+}
+
+async function deleteRolesFromGroup(body) {
+  return (0, _fetch.Delete)(`${_constants.urls.identity.groups.roles.v1}`, body);
+}
+
+async function addUsersToGroup(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.groups.users.v1}`, body);
+}
+
+async function deleteUsersFromGroup(body) {
+  return (0, _fetch.Delete)(`${_constants.urls.identity.groups.users.v1}`, body);
+}
+
+async function getGroupConfiguration() {
+  return (0, _fetch.Get)(`${_constants.urls.identity.groups.configurations.v1}`);
+}
+
+async function updateGroupConfiguration(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.groups.configurations.v1}`, body);
+}

package/node/groups/interfaces.js

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

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.74
+/** @license Frontegg v3.0.76
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/package.json

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