@frontegg/rest-api 7.68.0 → 7.69.0-alpha.1

package/auth/index.d.ts

@@ -3,7 +3,7 @@ export * from './enums';
 export { FRONTEGG_SEPARATE_TABS_BY_TENANT } from './constants';
 export { setTabTenantInSessionStorage, getTabTenantFromSessionStorage, getCurrentUserTenantsFunction, removeTabTenantFromSessionStorage, } from './utils';
 import { ISamlRolesGroup } from '../teams/interfaces';
-import { IAcceptInvitation, IAcceptInvitationWithOTC, IActivateAccount, IActivateAccountWithOTC, 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, ICreateOrUpdateSSOConfigurationByMetadataUrl, GenerateStepUpRequest, GenerateStepUpResponse, TSignupStrategyResponse } from './interfaces';
+import { IAcceptInvitation, IAcceptInvitationWithOTC, IActivateAccount, IActivateAccountWithOTC, 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, ICreateOrUpdateSSOConfigurationByMetadataUrl, GenerateStepUpRequest, GenerateStepUpResponse, TSignupStrategyResponse, IPasswordRecoveryStrategy } from './interfaces';
 import { IGetUserAuthorizationResponse, IUserProfile } from '../users/interfaces';
 import { BaseApiClient } from '../BaseApiClient';
 import { SecurityPolicyApi } from './secutiry-poilicy';
@@ -843,6 +843,10 @@ export declare class AuthenticationApi extends BaseApiClient {
     testCurrentIp: () => Promise<import("./interfaces").IPValidResponse>;
     /** @deprecated use api.auth.securityPolicy.testCurrentIpInAllowList() or api.securityPolicy.testCurrentIpInAllowList() instead */
     testCurrentIpInAllowList: () => Promise<import("./interfaces").IPValidResponse>;
+    /**
+     * Get the available password recovery strategies for the vendor.
+     */
+    getPasswordRecoveryStrategies: () => Promise<IPasswordRecoveryStrategy[]>;
 }
 declare const _default: AuthenticationApi;
 export default _default;

package/auth/index.js

@@ -802,6 +802,9 @@ export class AuthenticationApi extends BaseApiClient {
     this.deleteIPRestriction = this.securityPolicy.deleteIPRestriction.bind(this.securityPolicy);
     this.testCurrentIp = this.securityPolicy.testCurrentIp.bind(this.securityPolicy);
     this.testCurrentIpInAllowList = this.securityPolicy.testCurrentIpInAllowList.bind(this.securityPolicy);
+    this.getPasswordRecoveryStrategies = async () => {
+      return this.get(`${urls.identity.configurations.v1}/password-recovery/strategies`);
+    };
   }
   /**
    * @returns true if entitlements load should be done

package/auth/interfaces.d.ts

@@ -101,6 +101,9 @@ export type IResendInvitationEmail = {
 export type IForgotPassword = {
     email: string;
 };
+export type IDeterminatePasswordRecoveryStrategy = {
+    identifier: string;
+};
 export type IResetPassword = {
     token: string;
     userId: string;
@@ -714,3 +717,11 @@ export type TSignupStrategy = {
     isRequired: boolean;
 };
 export type TSignupStrategyResponse = Array<TSignupStrategy>;
+export declare enum PasswordRecoveryStrategyEnum {
+    EMAIL = "email",
+    SMS = "sms"
+}
+export interface IPasswordRecoveryStrategy {
+    strategy: PasswordRecoveryStrategyEnum;
+    isActive: boolean;
+}

package/auth/interfaces.js

@@ -22,4 +22,9 @@ export let MFAStrategyEnum;
   MFAStrategyEnum["SMS"] = "SMS";
   MFAStrategyEnum["EmailCode"] = "EmailCode";
 })(MFAStrategyEnum || (MFAStrategyEnum = {}));
-export const LOAD_AUTHORIZATION_FF = 'admin_portal_should_load_authorization';
+export const LOAD_AUTHORIZATION_FF = 'admin_portal_should_load_authorization';
+export let PasswordRecoveryStrategyEnum;
+(function (PasswordRecoveryStrategyEnum) {
+  PasswordRecoveryStrategyEnum["EMAIL"] = "email";
+  PasswordRecoveryStrategyEnum["SMS"] = "sms";
+})(PasswordRecoveryStrategyEnum || (PasswordRecoveryStrategyEnum = {}));

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v7.68.0
+/** @license Frontegg v7.69.0-alpha.1
  *
  * 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

@@ -868,6 +868,9 @@ class AuthenticationApi extends _BaseApiClient.BaseApiClient {
     this.deleteIPRestriction = this.securityPolicy.deleteIPRestriction.bind(this.securityPolicy);
     this.testCurrentIp = this.securityPolicy.testCurrentIp.bind(this.securityPolicy);
     this.testCurrentIpInAllowList = this.securityPolicy.testCurrentIpInAllowList.bind(this.securityPolicy);
+    this.getPasswordRecoveryStrategies = async () => {
+      return this.get(`${_constants2.urls.identity.configurations.v1}/password-recovery/strategies`);
+    };
   }
   /**
    * @returns true if entitlements load should be done

package/node/auth/interfaces.js

@@ -7,9 +7,10 @@ var _exportNames = {
   SecondaryAuthStrategy: true,
   WebAuthnDeviceType: true,
   MFAStrategyEnum: true,
-  LOAD_AUTHORIZATION_FF: true
+  LOAD_AUTHORIZATION_FF: true,
+  PasswordRecoveryStrategyEnum: true
 };
-exports.WebAuthnDeviceType = exports.SecondaryAuthStrategy = exports.MFAStrategyEnum = exports.LOAD_AUTHORIZATION_FF = void 0;
+exports.WebAuthnDeviceType = exports.SecondaryAuthStrategy = exports.PasswordRecoveryStrategyEnum = exports.MFAStrategyEnum = exports.LOAD_AUTHORIZATION_FF = void 0;
 var _interfaces = require("./secutiry-poilicy/interfaces");
 Object.keys(_interfaces).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -49,4 +50,10 @@ exports.MFAStrategyEnum = MFAStrategyEnum;
   MFAStrategyEnum["EmailCode"] = "EmailCode";
 })(MFAStrategyEnum || (exports.MFAStrategyEnum = MFAStrategyEnum = {}));
 const LOAD_AUTHORIZATION_FF = 'admin_portal_should_load_authorization';
-exports.LOAD_AUTHORIZATION_FF = LOAD_AUTHORIZATION_FF;
+exports.LOAD_AUTHORIZATION_FF = LOAD_AUTHORIZATION_FF;
+let PasswordRecoveryStrategyEnum;
+exports.PasswordRecoveryStrategyEnum = PasswordRecoveryStrategyEnum;
+(function (PasswordRecoveryStrategyEnum) {
+  PasswordRecoveryStrategyEnum["EMAIL"] = "email";
+  PasswordRecoveryStrategyEnum["SMS"] = "sms";
+})(PasswordRecoveryStrategyEnum || (exports.PasswordRecoveryStrategyEnum = PasswordRecoveryStrategyEnum = {}));

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v7.68.0
+/** @license Frontegg v7.69.0-alpha.1
  *
  * 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": "7.68.0",
+  "version": "7.69.0-alpha.1",
   "main": "./node/index.js",
   "license": "MIT",
   "author": "Frontegg LTD",