@frontegg/rest-api 3.0.40 → 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/index.js

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

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/index.js

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

package/package.json

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