@frontegg/rest-api 7.76.0-alpha.2 → 7.76.0

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, IPasswordRecoveryStrategy } 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, IForgotPasswordV2, IResetPasswordViaSmsResponse, IVerifyPasswordViaSmsRequest, IVerifyPasswordViaSmsResponse } from './interfaces';
 import { IGetUserAuthorizationResponse, IUserProfile } from '../users/interfaces';
 import { BaseApiClient } from '../BaseApiClient';
 import { SecurityPolicyApi } from './secutiry-poilicy';
@@ -157,6 +157,19 @@ export declare class AuthenticationApi extends BaseApiClient {
      * @throws exception if the user not found, password validation failed or invalid token.
      */
     resetPassword: (body: IResetPassword) => Promise<void>;
+    /**
+     * calling reset password via email will send an email with a link to reset user's password.
+     * @throws exception if the user not found
+     */
+    resetPasswordViaEmail: (body: IForgotPasswordV2) => Promise<void>;
+    /**
+     * calling reset password via sms will send an sms with an otc token.
+     */
+    resetPasswordViaSms: (body: IForgotPasswordV2) => Promise<IResetPasswordViaSmsResponse>;
+    /**
+     * calling verify password via sms will verify the otc token and return the user id and token.
+     */
+    verifyPasswordViaSms: (body: IVerifyPasswordViaSmsRequest) => Promise<IVerifyPasswordViaSmsResponse>;
     /**
      * Get the available password recovery strategies for the vendor.
      */

package/auth/index.js

@@ -210,6 +210,15 @@ export class AuthenticationApi extends BaseApiClient {
     this.resetPassword = async body => {
       return this.post(`${urls.identity.users.v1}/passwords/reset/verify`, body);
     };
+    this.resetPasswordViaEmail = async body => {
+      return this.post(`${urls.identity.users.v2}/passwords/reset/email`, body);
+    };
+    this.resetPasswordViaSms = async body => {
+      return this.post(`${urls.identity.users.v2}/passwords/reset/sms`, body);
+    };
+    this.verifyPasswordViaSms = async body => {
+      return this.post(`${urls.identity.users.v2}/passwords/reset/sms/verify`, body);
+    };
     this.getPasswordRecoveryStrategies = async () => {
       return this.get(`${urls.identity.configurations.v1}/password-recovery/strategies`);
     };

package/auth/interfaces.d.ts

@@ -1,6 +1,6 @@
 import { UserEntitlementsContext as UserEntitlementsResponseV2 } from '@frontegg/entitlements-javascript-commons';
 import { ITenantsResponse, IUserProfile } from '..';
-import { AuthStrategyEnum, MachineToMachineAuthStrategy, PasswordRecoveryStrategyEnum, SignUpStrategyEnum, SocialLoginProviders } from './enums';
+import { AuthStrategyEnum, EIdentifierType, MachineToMachineAuthStrategy, PasswordRecoveryStrategyEnum, SignUpStrategyEnum, SocialLoginProviders } from './enums';
 import { ISamlRolesGroup } from '../teams/interfaces';
 export * from './secutiry-poilicy/interfaces';
 export type IPreLogin = {
@@ -103,6 +103,21 @@ export type IResendInvitationEmail = {
 export type IForgotPassword = {
     email: string;
 };
+export type IForgotPasswordV2 = {
+    identifier: string;
+    identifierType: EIdentifierType;
+};
+export type IResetPasswordViaSmsResponse = {
+    sessionId: string;
+};
+export type IVerifyPasswordViaSmsRequest = {
+    otcToken: string;
+    sessionId: string;
+};
+export type IVerifyPasswordViaSmsResponse = {
+    userId: string;
+    token: string;
+};
 export type IResetPassword = {
     token: string;
     userId: string;

package/auth/interfaces.js

@@ -1,3 +1,5 @@
+EIdentifierType;
+import { EIdentifierType } from './enums';
 export * from './secutiry-poilicy/interfaces';
 // SmsCode is for speedy login, SmsCodeV2 is for login with SMS
 export let SecondaryAuthStrategy;

package/index.js

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

@@ -275,6 +275,15 @@ class AuthenticationApi extends _BaseApiClient.BaseApiClient {
     this.resetPassword = async body => {
       return this.post(`${_constants2.urls.identity.users.v1}/passwords/reset/verify`, body);
     };
+    this.resetPasswordViaEmail = async body => {
+      return this.post(`${_constants2.urls.identity.users.v2}/passwords/reset/email`, body);
+    };
+    this.resetPasswordViaSms = async body => {
+      return this.post(`${_constants2.urls.identity.users.v2}/passwords/reset/sms`, body);
+    };
+    this.verifyPasswordViaSms = async body => {
+      return this.post(`${_constants2.urls.identity.users.v2}/passwords/reset/sms/verify`, body);
+    };
     this.getPasswordRecoveryStrategies = async () => {
       return this.get(`${_constants2.urls.identity.configurations.v1}/password-recovery/strategies`);
     };

package/node/auth/interfaces.js

@@ -10,6 +10,7 @@ var _exportNames = {
   LOAD_AUTHORIZATION_FF: true
 };
 exports.WebAuthnDeviceType = exports.SecondaryAuthStrategy = exports.MFAStrategyEnum = exports.LOAD_AUTHORIZATION_FF = void 0;
+var _enums = require("./enums");
 var _interfaces = require("./secutiry-poilicy/interfaces");
 Object.keys(_interfaces).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -22,6 +23,7 @@ Object.keys(_interfaces).forEach(function (key) {
     }
   });
 });
+_enums.EIdentifierType;
 // SmsCode is for speedy login, SmsCodeV2 is for login with SMS
 let SecondaryAuthStrategy;
 exports.SecondaryAuthStrategy = SecondaryAuthStrategy;

package/node/index.js

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