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

package/auth/enums.d.ts

@@ -27,3 +27,12 @@ export declare enum SignUpStrategyEnum {
     Email = "email",
     PhoneNumber = "phoneNumber"
 }
+export declare enum EIdentifierType {
+    email = "email",
+    phoneNumber = "phoneNumber",
+    username = "username"
+}
+export declare enum PasswordRecoveryStrategyEnum {
+    Email = "email",
+    Sms = "sms"
+}

package/auth/enums.js

@@ -30,4 +30,15 @@ export let SignUpStrategyEnum;
 (function (SignUpStrategyEnum) {
   SignUpStrategyEnum["Email"] = "email";
   SignUpStrategyEnum["PhoneNumber"] = "phoneNumber";
-})(SignUpStrategyEnum || (SignUpStrategyEnum = {}));
+})(SignUpStrategyEnum || (SignUpStrategyEnum = {}));
+export let EIdentifierType;
+(function (EIdentifierType) {
+  EIdentifierType["email"] = "email";
+  EIdentifierType["phoneNumber"] = "phoneNumber";
+  EIdentifierType["username"] = "username";
+})(EIdentifierType || (EIdentifierType = {}));
+export let PasswordRecoveryStrategyEnum;
+(function (PasswordRecoveryStrategyEnum) {
+  PasswordRecoveryStrategyEnum["Email"] = "email";
+  PasswordRecoveryStrategyEnum["Sms"] = "sms";
+})(PasswordRecoveryStrategyEnum || (PasswordRecoveryStrategyEnum = {}));

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';
@@ -157,6 +157,10 @@ export declare class AuthenticationApi extends BaseApiClient {
      * @throws exception if the user not found, password validation failed or invalid token.
      */
     resetPassword: (body: IResetPassword) => Promise<void>;
+    /**
+     * Get the available password recovery strategies for the vendor.
+     */
+    getPasswordRecoveryStrategies: () => Promise<IPasswordRecoveryStrategy[]>;
     /**
      * load password configuration for user.
      */

package/auth/index.js

@@ -210,6 +210,9 @@ export class AuthenticationApi extends BaseApiClient {
     this.resetPassword = async body => {
       return this.post(`${urls.identity.users.v1}/passwords/reset/verify`, body);
     };
+    this.getPasswordRecoveryStrategies = async () => {
+      return this.get(`${urls.identity.configurations.v1}/password-recovery/strategies`);
+    };
     this.loadPasswordConfig = async params => {
       return this.get(`${urls.identity.users.v1}/passwords/config`, params);
     };

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, SignUpStrategyEnum, SocialLoginProviders } from './enums';
+import { AuthStrategyEnum, MachineToMachineAuthStrategy, PasswordRecoveryStrategyEnum, SignUpStrategyEnum, SocialLoginProviders } from './enums';
 import { ISamlRolesGroup } from '../teams/interfaces';
 export * from './secutiry-poilicy/interfaces';
 export type IPreLogin = {
@@ -723,3 +723,7 @@ export type TSignupStrategy = {
     isRequired: boolean;
 };
 export type TSignupStrategyResponse = Array<TSignupStrategy>;
+export interface IPasswordRecoveryStrategy {
+    strategy: PasswordRecoveryStrategyEnum;
+    isActive: boolean;
+}

package/index.d.ts

@@ -1,4 +1,4 @@
-import { AuthStrategyEnum, MachineToMachineAuthStrategy, SocialLoginProviders } from './auth';
+import { AuthStrategyEnum, EIdentifierType, MachineToMachineAuthStrategy, SocialLoginProviders } from './auth';
 import { ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType } from './subscriptions';
 import { FronteggApiError } from './error';
 import fetch, { FetchClient } from './FetchClient';
@@ -123,7 +123,7 @@ export type FronteggApiClient = {
     userEmailPolicy: UserEmailPolicyApi;
 };
 declare const createApiClient: (appName: string) => FronteggApiClient;
-export { fetch, FetchClient, ContextHolder, FronteggContext, api, createApiClient, FronteggApiError, AuthStrategyEnum, SocialLoginProviders, ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType, MachineToMachineAuthStrategy, };
+export { fetch, FetchClient, ContextHolder, FronteggContext, api, createApiClient, FronteggApiError, AuthStrategyEnum, SocialLoginProviders, ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType, MachineToMachineAuthStrategy, EIdentifierType, };
 declare const _default: {
     fetch: FetchClient;
     FetchClient: typeof FetchClient;
@@ -184,5 +184,6 @@ declare const _default: {
     ISubscriptionStatus: typeof ISubscriptionStatus;
     PaymentMethodType: typeof PaymentMethodType;
     ProviderType: typeof ProviderType;
+    EIdentifierType: typeof EIdentifierType;
 };
 export default _default;

package/index.js

@@ -1,9 +1,9 @@
-/** @license Frontegg v7.76.0-alpha.0
+/** @license Frontegg v7.76.0-alpha.2
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { AuthStrategyEnum, MachineToMachineAuthStrategy, SocialLoginProviders } from './auth';
+import { AuthStrategyEnum, EIdentifierType, MachineToMachineAuthStrategy, SocialLoginProviders } from './auth';
 import { ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType } from './subscriptions';
 import { FronteggApiError } from './error';
 import fetch, { FetchClient } from './FetchClient';
@@ -127,7 +127,7 @@ const createApiClient = appName => ({
   usernames: new UsernamesApi(appName),
   userEmailPolicy: new UserEmailPolicyApi(appName)
 });
-export { fetch, FetchClient, ContextHolder, FronteggContext, api, createApiClient, FronteggApiError, AuthStrategyEnum, SocialLoginProviders, ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType, MachineToMachineAuthStrategy };
+export { fetch, FetchClient, ContextHolder, FronteggContext, api, createApiClient, FronteggApiError, AuthStrategyEnum, SocialLoginProviders, ISubscriptionCancellationPolicy, ISubscriptionStatus, PaymentMethodType, ProviderType, MachineToMachineAuthStrategy, EIdentifierType };
 export default {
   fetch,
   FetchClient,
@@ -142,5 +142,6 @@ export default {
   ISubscriptionCancellationPolicy,
   ISubscriptionStatus,
   PaymentMethodType,
-  ProviderType
+  ProviderType,
+  EIdentifierType
 };

package/node/auth/enums.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.SocialLoginProviders = exports.SignUpStrategyEnum = exports.MachineToMachineAuthStrategy = exports.AuthStrategyEnum = void 0;
+exports.SocialLoginProviders = exports.SignUpStrategyEnum = exports.PasswordRecoveryStrategyEnum = exports.MachineToMachineAuthStrategy = exports.EIdentifierType = exports.AuthStrategyEnum = void 0;
 let SocialLoginProviders;
 exports.SocialLoginProviders = SocialLoginProviders;
 (function (SocialLoginProviders) {
@@ -40,4 +40,17 @@ exports.SignUpStrategyEnum = SignUpStrategyEnum;
 (function (SignUpStrategyEnum) {
   SignUpStrategyEnum["Email"] = "email";
   SignUpStrategyEnum["PhoneNumber"] = "phoneNumber";
-})(SignUpStrategyEnum || (exports.SignUpStrategyEnum = SignUpStrategyEnum = {}));
+})(SignUpStrategyEnum || (exports.SignUpStrategyEnum = SignUpStrategyEnum = {}));
+let EIdentifierType;
+exports.EIdentifierType = EIdentifierType;
+(function (EIdentifierType) {
+  EIdentifierType["email"] = "email";
+  EIdentifierType["phoneNumber"] = "phoneNumber";
+  EIdentifierType["username"] = "username";
+})(EIdentifierType || (exports.EIdentifierType = EIdentifierType = {}));
+let PasswordRecoveryStrategyEnum;
+exports.PasswordRecoveryStrategyEnum = PasswordRecoveryStrategyEnum;
+(function (PasswordRecoveryStrategyEnum) {
+  PasswordRecoveryStrategyEnum["Email"] = "email";
+  PasswordRecoveryStrategyEnum["Sms"] = "sms";
+})(PasswordRecoveryStrategyEnum || (exports.PasswordRecoveryStrategyEnum = PasswordRecoveryStrategyEnum = {}));

package/node/auth/index.js

@@ -275,6 +275,9 @@ class AuthenticationApi extends _BaseApiClient.BaseApiClient {
     this.resetPassword = async body => {
       return this.post(`${_constants2.urls.identity.users.v1}/passwords/reset/verify`, body);
     };
+    this.getPasswordRecoveryStrategies = async () => {
+      return this.get(`${_constants2.urls.identity.configurations.v1}/password-recovery/strategies`);
+    };
     this.loadPasswordConfig = async params => {
       return this.get(`${_constants2.urls.identity.users.v1}/passwords/config`, params);
     };

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v7.76.0-alpha.0
+/** @license Frontegg v7.76.0-alpha.2
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -12,6 +12,7 @@ var _exportNames = {
   api: true,
   createApiClient: true,
   AuthStrategyEnum: true,
+  EIdentifierType: true,
   MachineToMachineAuthStrategy: true,
   SocialLoginProviders: true,
   setTabTenantInSessionStorage: true,
@@ -43,6 +44,12 @@ Object.defineProperty(exports, "ContextHolder", {
     return _ContextHolder.ContextHolder;
   }
 });
+Object.defineProperty(exports, "EIdentifierType", {
+  enumerable: true,
+  get: function () {
+    return _auth.EIdentifierType;
+  }
+});
 Object.defineProperty(exports, "FRONTEGG_SEPARATE_TABS_BY_TENANT", {
   enumerable: true,
   get: function () {
@@ -615,6 +622,7 @@ var _default = {
   ISubscriptionCancellationPolicy: _subscriptions.ISubscriptionCancellationPolicy,
   ISubscriptionStatus: _subscriptions.ISubscriptionStatus,
   PaymentMethodType: _subscriptions.PaymentMethodType,
-  ProviderType: _subscriptions.ProviderType
+  ProviderType: _subscriptions.ProviderType,
+  EIdentifierType: _auth.EIdentifierType
 };
 exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontegg/rest-api",
-  "version": "7.76.0-alpha.0",
+  "version": "7.76.0-alpha.2",
   "main": "./node/index.js",
   "license": "MIT",
   "author": "Frontegg LTD",