@frontegg/rest-api 3.0.123 → 3.0.125

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, IWebAuthnDevices, ICustomSocialLoginProviderConfigurationV1, ILoginResponseV3 } 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, ICustomSocialLoginProviderConfigurationV1, ILoginResponseV3, IPreVerifyMFAEmailCodeResponse, IVerifyMFAEmailCode } from './interfaces';
 /*****************************************
  * Authentication
  *****************************************/
@@ -244,6 +244,16 @@ export declare function enrollMFAAuthenticatorAppForLogin(body: IEnrollMFAAuthen
  * with the selected authenticator app id, mfaToken and the generated code from your authenticator app.
  */
 export declare function verifyMFAAuthenticatorAppForLogin(deviceId: string, body: IVerifyMFAAuthenticatorApp): Promise<ILoginResponse>;
+/**
+ * pre verify Multi-Factor Email Code
+ * the server returns otcToken that should be sent to the verify function with the code that was sent to
+ */
+export declare function preVerifyMFAEmailCode(body: IPreVerifyMFA): Promise<IPreVerifyMFAEmailCodeResponse>;
+/**
+ * after pre verify with Email Code, verify Email Code function should be called
+ * with the otcToken and the code that has been sent to the email
+ */
+export declare function verifyMFAEmailCode(body: IVerifyMFAEmailCode): Promise<ILoginResponse>;
 /**
  * pre enroll Multi-Factor to use with SMS
  * the server returns otcToken that should be sent to the enroll function with the code that was sent to

package/auth/index.js

@@ -207,6 +207,12 @@ export async function enrollMFAAuthenticatorAppForLogin(body) {
 export async function verifyMFAAuthenticatorAppForLogin(deviceId, body) {
   return Post(`${urls.identity.auth.v1}/user/mfa/authenticator/${deviceId}/verify`, body);
 }
+export async function preVerifyMFAEmailCode(body) {
+  return Post(`${urls.identity.auth.v1}/user/mfa/emailcode`, body);
+}
+export async function verifyMFAEmailCode(body) {
+  return Post(`${urls.identity.auth.v1}/user/mfa/emailcode/verify`, body);
+}
 export async function preEnrollMFASMSForLogin(body) {
   return Post(`${urls.identity.auth.v1}/user/mfa/sms/enroll`, body);
 }

package/auth/interfaces.d.ts

@@ -43,6 +43,7 @@ export declare type ILoginResponse = IUserProfile & {
     userEmail?: string;
     mfaStrategies?: MFAStrategyEnum[];
     mfaDevices?: UserMFADevicesResponse;
+    isBreachedPassword?: boolean;
 };
 export declare type ILoginResponseV2 = {
     user: ILoginResponse;
@@ -569,16 +570,25 @@ export interface IVerifyMFA {
     mfaToken: string;
     rememberDevice?: boolean;
 }
+export interface IPreVerifyCode {
+    otcToken: string;
+}
+export interface IVerifyCode extends IVerifyMFA {
+    otcToken: string;
+    code: string;
+}
 export interface IVerifyMFAAuthenticatorApp extends IVerifyMFA {
     value: string;
 }
-export interface IPreVerifyMFASMSResponse {
-    otcToken: string;
+export interface IPreVerifyMFASMSResponse extends IPreVerifyCode {
     phoneNumber: string;
 }
-export interface IVerifyMFASMS extends IVerifyMFA {
+export interface IVerifyMFASMS extends IVerifyCode {
+}
+export interface IPreVerifyMFAEmailCodeResponse {
     otcToken: string;
-    code: string;
+}
+export interface IVerifyMFAEmailCode extends IVerifyCode {
 }
 export interface IPreVerifyMFAWebAuthnResponse {
     webauthnToken: string;
@@ -592,7 +602,8 @@ export declare enum MFAStrategyEnum {
     AuthenticatorApp = "AuthenticatorApp",
     WebAuthnPlatform = "WebAuthnPlatform",
     WebAuthnCrossPlatform = "WebAuthnCrossPlatform",
-    SMS = "SMS"
+    SMS = "SMS",
+    EmailCode = "EmailCode"
 }
 export interface UserMFAWebAuthnDevice {
     id: string;

package/auth/interfaces.js

@@ -22,4 +22,5 @@ export let MFAStrategyEnum;
   MFAStrategyEnum["WebAuthnPlatform"] = "WebAuthnPlatform";
   MFAStrategyEnum["WebAuthnCrossPlatform"] = "WebAuthnCrossPlatform";
   MFAStrategyEnum["SMS"] = "SMS";
+  MFAStrategyEnum["EmailCode"] = "EmailCode";
 })(MFAStrategyEnum || (MFAStrategyEnum = {}));

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.123
+/** @license Frontegg v3.0.125
  *
  * 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

@@ -48,6 +48,8 @@ var _exportNames = {
   preEnrollMFAAuthenticatorAppForLogin: true,
   enrollMFAAuthenticatorAppForLogin: true,
   verifyMFAAuthenticatorAppForLogin: true,
+  preVerifyMFAEmailCode: true,
+  verifyMFAEmailCode: true,
   preEnrollMFASMSForLogin: true,
   enrollMFASMSForLogin: true,
   preVerifyMFASMSForLogin: true,
@@ -221,6 +223,7 @@ exports.preEnrollMFAWebAuthnForLogin = preEnrollMFAWebAuthnForLogin;
 exports.preLogin = preLogin;
 exports.preLoginV2 = preLoginV2;
 exports.preLoginWithIdpType = preLoginWithIdpType;
+exports.preVerifyMFAEmailCode = preVerifyMFAEmailCode;
 exports.preVerifyMFASMSForLogin = preVerifyMFASMSForLogin;
 exports.preVerifyMFAWebAuthnForLogin = preVerifyMFAWebAuthnForLogin;
 exports.recoverMfaToken = recoverMfaToken;
@@ -249,6 +252,7 @@ exports.validateSamlDomain = validateSamlDomain;
 exports.verifyChangePhoneNumber = verifyChangePhoneNumber;
 exports.verifyInviteToken = verifyInviteToken;
 exports.verifyMFAAuthenticatorAppForLogin = verifyMFAAuthenticatorAppForLogin;
+exports.verifyMFAEmailCode = verifyMFAEmailCode;
 exports.verifyMFASMSForLogin = verifyMFASMSForLogin;
 exports.verifyMFAWebAuthnForLogin = verifyMFAWebAuthnForLogin;
 exports.verifyMfa = verifyMfa;
@@ -548,6 +552,14 @@ async function verifyMFAAuthenticatorAppForLogin(deviceId, body) {
   return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/authenticator/${deviceId}/verify`, body);
 }
 
+async function preVerifyMFAEmailCode(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/emailcode`, body);
+}
+
+async function verifyMFAEmailCode(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/emailcode/verify`, body);
+}
+
 async function preEnrollMFASMSForLogin(body) {
   return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/sms/enroll`, body);
 }

package/node/auth/interfaces.js

@@ -49,4 +49,5 @@ exports.MFAStrategyEnum = MFAStrategyEnum;
   MFAStrategyEnum["WebAuthnPlatform"] = "WebAuthnPlatform";
   MFAStrategyEnum["WebAuthnCrossPlatform"] = "WebAuthnCrossPlatform";
   MFAStrategyEnum["SMS"] = "SMS";
+  MFAStrategyEnum["EmailCode"] = "EmailCode";
 })(MFAStrategyEnum || (exports.MFAStrategyEnum = MFAStrategyEnum = {}));

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.123
+/** @license Frontegg v3.0.125
  *
  * 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.123",
+  "version": "3.0.125",
   "main": "./node/index.js",
   "license": "MIT",
   "dependencies": {