@frontegg/rest-api 3.0.39 → 3.0.41

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 } 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 } from "./interfaces";
 /*****************************************
  * Authentication
  *****************************************/
@@ -129,6 +129,39 @@ export declare function recoverMfaToken(body: IRecoverMFAToken): Promise<void>;
  * ``authorized user``
  */
 export declare function enrollMfa(): Promise<IEnrollMfaResponse>;
+/**
+ * pre enroll Multi-Factor Auth Code to use in 3rd party apps like Google Authenticator.
+ * the server returns qrCode as png image in base64 format
+ *
+ * @throws exception if the user already have mfa-enabled
+ * ``authorized user``
+ */
+export declare function preEnrollMFAAuthenticatorApp(): Promise<IPreEnrollMFAAuthenticatorAppResponse>;
+/**
+ * enroll Multi-Factor Auth Code to use in 3rd party apps like Google Authenticator.
+ */
+export declare function enrollMFAAuthenticatorApp(body: WithoutMFAToken<IEnrollMFAAuthenticatorApp>): Promise<void>;
+/**
+ * pre enroll Multi-Factor SMS
+ * the server returns otcToken that should be sent to the enroll function with the code that was sent to
+ */
+export declare function preEnrollMFASMS(): Promise<IPreEnrollMFASMSResponse>;
+/**
+ * after pre enroll with SMS, enroll SMS function should be called
+ * with the otcToken and the code that has been sent to the phone number that was requested
+ */
+export declare function enrollMFASMS(body: WithoutMFAToken<IEnrollMFASMS>): Promise<void>;
+/**
+ * pre enroll Multi-Factor to use with WebAuthn
+ * the server returns attestation object
+ * the request phone number
+ */
+export declare function preEnrollMFAWebAuthn(): Promise<IPreEnrollMFAWebAuthnResponse>;
+/**
+ * after pre enroll with WebAuthn, enroll WebAuthn function should be called
+ * with the webauthnToken and the attestation object response
+ */
+export declare function enrollMFAWebAuthn(body: WithoutMFAToken<IEnrollMFAWebAuthn>): Promise<void>;
 /**
  * after enrolling MFA QR code, verify function should be called
  * with the generated code in the Authenticator App
@@ -559,3 +592,7 @@ export declare function verifyNewDeviceSession(body: IVerifyNewWebAuthnDevice):
  * Get public vendor auth strategies public configuration
  */
 export declare function getVendorPublicAuthStrategiesConfig(): Promise<IAuthStrategiesConfig>;
+/**
+ * Get vendor mfa strategies configuration
+ */
+export declare function getMFAStrategiesConfig(): Promise<IMFAStrategiesResponse>;

package/auth/index.js

@@ -128,6 +128,24 @@ export async function recoverMfaToken(body) {
 export async function enrollMfa() {
   return Post(`${urls.identity.users.v1}/mfa/enroll`);
 }
+export async function preEnrollMFAAuthenticatorApp() {
+  return Post(`${urls.identity.users.v1}/mfa/authenticator/enroll`);
+}
+export async function enrollMFAAuthenticatorApp(body) {
+  return Post(`${urls.identity.users.v1}/mfa/authenticator/enroll/verify`, body);
+}
+export async function preEnrollMFASMS() {
+  return Post(`${urls.identity.users.v1}/mfa/sms/enroll`);
+}
+export async function enrollMFASMS(body) {
+  return Post(`${urls.identity.users.v1}/mfa/sms/enroll/verify`, body);
+}
+export async function preEnrollMFAWebAuthn() {
+  return Post(`${urls.identity.users.v1}/mfa/webauthn/enroll`);
+}
+export async function enrollMFAWebAuthn(body) {
+  return Post(`${urls.identity.users.v1}/mfa/webauthn/enroll/verify`, body);
+}
 export async function verifyMfa(body) {
   return Post(`${urls.identity.users.v1}/mfa/enroll/verify`, body);
 }
@@ -474,4 +492,6 @@ export async function verifyNewDeviceSession(body) {
 export async function getVendorPublicAuthStrategiesConfig() {
   return Get(`${urls.identity.configurations.v1}/auth/strategies/public`);
 }
-;
+export async function getMFAStrategiesConfig() {
+  return Get(`${urls.identity.configurations.v1}/mfa/strategies`);
+}

package/auth/interfaces.d.ts

@@ -549,3 +549,14 @@ export interface IDisableMFAWebAuthn {
     webauthnToken?: string;
     options?: Omit<IWebAuthnPostLogin, "recaptchaToken" | "invitationToken">;
 }
+export interface IPreEnrollMFAAuthenticatorApp {
+    qrCode: string;
+}
+export declare type WithoutMFAToken<T> = Omit<T | 'mfaToken', 'rememberDevice'>;
+export interface IMFAStrategyResponse {
+    strategy: MFAStrategyEnum;
+    isActive: boolean;
+}
+export interface IMFAStrategiesResponse {
+    strategies: IMFAStrategyResponse[];
+}

package/constants.d.ts

@@ -184,4 +184,7 @@ export declare const urls: {
     featureFlags: {
         v1: string;
     };
+    directory: {
+        v1: string;
+    };
 };

package/constants.js

@@ -183,5 +183,8 @@ export const urls = {
   },
   featureFlags: {
     v1: '/flags'
+  },
+  directory: {
+    v1: '/directory/resources/v1/configurations/scim2'
   }
 };

package/directory/index.d.ts

@@ -0,0 +1,17 @@
+import { Scim2ConnectionConfigResponse, Scim2CreateConnectionConfigRequest, Scim2PatchConnectionConfigRequest } from './interfaces';
+/**
+ * returns all scim2 configurations
+ *
+ * ``authorized user``
+ */
+export declare function getConfigs(): Promise<Scim2ConnectionConfigResponse>;
+/**
+ * update scim2 configuration
+ * ``authorized user``
+ */
+export declare function updateConfiguration(id: string, body: Scim2PatchConnectionConfigRequest): Promise<Scim2ConnectionConfigResponse>;
+/**
+ * create scim2 configuration
+ * ``authorized user``
+ */
+export declare function createConfiguration(id: string, body: Scim2CreateConnectionConfigRequest): Promise<Scim2ConnectionConfigResponse>;

package/directory/index.js

@@ -0,0 +1,11 @@
+import { urls } from '../constants';
+import { Get, Patch, Post } from '../fetch';
+export async function getConfigs() {
+  return Get(`${urls.directory.v1}`);
+}
+export async function updateConfiguration(id, body) {
+  return Patch(`${urls.directory.v1}/${id}`, body);
+}
+export async function createConfiguration(id, body) {
+  return Post(`${urls.directory.v1}`, body);
+}

package/directory/interfaces.d.ts

@@ -0,0 +1,21 @@
+export declare enum ScimConnectionSource {
+    FRONTEGG = "frontegg",
+    OKTA = "okta",
+    AZURE_AD = "azure-ad",
+    OTHER = "other"
+}
+export interface Scim2ConnectionConfigResponse {
+    id: string;
+    connectionName: string;
+    source: ScimConnectionSource;
+    syncToUserManagement: boolean;
+    lastSync?: Date | null;
+}
+export interface Scim2CreateConnectionConfigRequest {
+    source: ScimConnectionSource;
+    connectionName?: string;
+    syncToUserManagement?: boolean;
+}
+export interface Scim2PatchConnectionConfigRequest {
+    syncToUserManagement?: boolean;
+}

package/directory/interfaces.js

@@ -0,0 +1,8 @@
+export let ScimConnectionSource;
+
+(function (ScimConnectionSource) {
+  ScimConnectionSource["FRONTEGG"] = "frontegg";
+  ScimConnectionSource["OKTA"] = "okta";
+  ScimConnectionSource["AZURE_AD"] = "azure-ad";
+  ScimConnectionSource["OTHER"] = "other";
+})(ScimConnectionSource || (ScimConnectionSource = {}));

package/directory/package.json

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

package/index.d.ts

@@ -32,6 +32,8 @@ export * from './sub-tenants/interfaces';
 export * from './routers';
 export * from './feature-flags';
 export * from './feature-flags/interfaces';
+export * from './directory';
+export * from './directory/interfaces';
 import { AuthStrategyEnum, SocialLoginProviders } from './auth';
 import { ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType } from './subscriptions';
 declare const api: {

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.39
+/** @license Frontegg v3.0.41
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -37,6 +37,8 @@ export * from './sub-tenants/interfaces';
 export * from './routers';
 export * from './feature-flags';
 export * from './feature-flags/interfaces';
+export * from './directory';
+export * from './directory/interfaces';
 import { AuthStrategyEnum, SocialLoginProviders } from './auth';
 import { ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType } from './subscriptions';
 const api = {

package/node/auth/index.js

@@ -28,6 +28,12 @@ var _exportNames = {
   loadPasswordConfig: true,
   recoverMfaToken: true,
   enrollMfa: true,
+  preEnrollMFAAuthenticatorApp: true,
+  enrollMFAAuthenticatorApp: true,
+  preEnrollMFASMS: true,
+  enrollMFASMS: true,
+  preEnrollMFAWebAuthn: true,
+  enrollMFAWebAuthn: true,
   verifyMfa: true,
   disableMfa: true,
   disableMFAAuthenticatorApp: true,
@@ -111,7 +117,8 @@ var _exportNames = {
   webAuthnPostLogin: true,
   webAuthnCreateNewDeviceSession: true,
   verifyNewDeviceSession: true,
-  getVendorPublicAuthStrategiesConfig: true
+  getVendorPublicAuthStrategiesConfig: true,
+  getMFAStrategiesConfig: true
 };
 exports.acceptInvitation = acceptInvitation;
 exports.activateAccount = activateAccount;
@@ -136,8 +143,11 @@ exports.disableMFAAuthenticatorApp = disableMFAAuthenticatorApp;
 exports.disableMFASMS = disableMFASMS;
 exports.disableMFAWebAuthn = disableMFAWebAuthn;
 exports.disableMfa = disableMfa;
+exports.enrollMFAAuthenticatorApp = enrollMFAAuthenticatorApp;
 exports.enrollMFAAuthenticatorAppForLogin = enrollMFAAuthenticatorAppForLogin;
+exports.enrollMFASMS = enrollMFASMS;
 exports.enrollMFASMSForLogin = enrollMFASMSForLogin;
+exports.enrollMFAWebAuthn = enrollMFAWebAuthn;
 exports.enrollMFAWebAuthnForLogin = enrollMFAWebAuthnForLogin;
 exports.enrollMfa = enrollMfa;
 exports.exchangeOAuthTokens = exchangeOAuthTokens;
@@ -149,6 +159,7 @@ exports.getActivateAccountStrategy = getActivateAccountStrategy;
 exports.getCurrentUserSession = getCurrentUserSession;
 exports.getCurrentUserSessions = getCurrentUserSessions;
 exports.getMFADevices = getMFADevices;
+exports.getMFAStrategiesConfig = getMFAStrategiesConfig;
 exports.getOidcConfiguration = getOidcConfiguration;
 exports.getSSOConfigurations = getSSOConfigurations;
 exports.getSSODefaultRoles = getSSODefaultRoles;
@@ -178,8 +189,11 @@ exports.passwordlessPreLogin = passwordlessPreLogin;
 exports.postLogin = postLogin;
 exports.preDisableMFASMS = preDisableMFASMS;
 exports.preDisableMFAWebAuthn = preDisableMFAWebAuthn;
+exports.preEnrollMFAAuthenticatorApp = preEnrollMFAAuthenticatorApp;
 exports.preEnrollMFAAuthenticatorAppForLogin = preEnrollMFAAuthenticatorAppForLogin;
+exports.preEnrollMFASMS = preEnrollMFASMS;
 exports.preEnrollMFASMSForLogin = preEnrollMFASMSForLogin;
+exports.preEnrollMFAWebAuthn = preEnrollMFAWebAuthn;
 exports.preEnrollMFAWebAuthnForLogin = preEnrollMFAWebAuthnForLogin;
 exports.preLogin = preLogin;
 exports.preLoginV2 = preLoginV2;
@@ -409,6 +423,30 @@ async function enrollMfa() {
   return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/enroll`);
 }
 
+async function preEnrollMFAAuthenticatorApp() {
+  return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/authenticator/enroll`);
+}
+
+async function enrollMFAAuthenticatorApp(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/authenticator/enroll/verify`, body);
+}
+
+async function preEnrollMFASMS() {
+  return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/sms/enroll`);
+}
+
+async function enrollMFASMS(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/sms/enroll/verify`, body);
+}
+
+async function preEnrollMFAWebAuthn() {
+  return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/webauthn/enroll`);
+}
+
+async function enrollMFAWebAuthn(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/webauthn/enroll/verify`, body);
+}
+
 async function verifyMfa(body) {
   return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/enroll/verify`, body);
 }
@@ -837,4 +875,6 @@ async function getVendorPublicAuthStrategiesConfig() {
   return (0, _fetch.Get)(`${_constants.urls.identity.configurations.v1}/auth/strategies/public`);
 }
 
-;
+async function getMFAStrategiesConfig() {
+  return (0, _fetch.Get)(`${_constants.urls.identity.configurations.v1}/mfa/strategies`);
+}

package/node/constants.js

@@ -189,6 +189,9 @@ const urls = {
   },
   featureFlags: {
     v1: '/flags'
+  },
+  directory: {
+    v1: '/directory/resources/v1/configurations/scim2'
   }
 };
 exports.urls = urls;

package/node/directory/index.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createConfiguration = createConfiguration;
+exports.getConfigs = getConfigs;
+exports.updateConfiguration = updateConfiguration;
+
+var _constants = require("../constants");
+
+var _fetch = require("../fetch");
+
+async function getConfigs() {
+  return (0, _fetch.Get)(`${_constants.urls.directory.v1}`);
+}
+
+async function updateConfiguration(id, body) {
+  return (0, _fetch.Patch)(`${_constants.urls.directory.v1}/${id}`, body);
+}
+
+async function createConfiguration(id, body) {
+  return (0, _fetch.Post)(`${_constants.urls.directory.v1}`, body);
+}

package/node/directory/interfaces.js

@@ -0,0 +1,15 @@
+"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/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.39
+/** @license Frontegg v3.0.41
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -349,6 +349,34 @@ Object.keys(_interfaces15).forEach(function (key) {
   });
 });
 
+var _directory = require("./directory");
+
+Object.keys(_directory).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _directory[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _directory[key];
+    }
+  });
+});
+
+var _interfaces16 = require("./directory/interfaces");
+
+Object.keys(_interfaces16).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _interfaces16[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _interfaces16[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; }

package/package.json

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