@frontegg/rest-api 7.66.0 → 7.67.0-alpha.0

package/auth/enums.d.ts

@@ -18,3 +18,7 @@ export declare enum MachineToMachineAuthStrategy {
     ClientCredentials = "ClientCredentials",
     AccessToken = "AccessToken"
 }
+export declare enum SignUpStrategyEnum {
+    Email = "email",
+    PhoneNumber = "phoneNumber"
+}

package/auth/enums.js

@@ -20,4 +20,9 @@ export let MachineToMachineAuthStrategy;
 (function (MachineToMachineAuthStrategy) {
   MachineToMachineAuthStrategy["ClientCredentials"] = "ClientCredentials";
   MachineToMachineAuthStrategy["AccessToken"] = "AccessToken";
-})(MachineToMachineAuthStrategy || (MachineToMachineAuthStrategy = {}));
+})(MachineToMachineAuthStrategy || (MachineToMachineAuthStrategy = {}));
+export let SignUpStrategyEnum;
+(function (SignUpStrategyEnum) {
+  SignUpStrategyEnum["Email"] = "email";
+  SignUpStrategyEnum["PhoneNumber"] = "phoneNumber";
+})(SignUpStrategyEnum || (SignUpStrategyEnum = {}));

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 } 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 } from './interfaces';
 import { IGetUserAuthorizationResponse, IUserProfile } from '../users/interfaces';
 import { BaseApiClient } from '../BaseApiClient';
 import { SecurityPolicyApi } from './secutiry-poilicy';
@@ -161,6 +161,10 @@ export declare class AuthenticationApi extends BaseApiClient {
      * load password configuration for user.
      */
     loadPasswordConfig: (params?: IGetUserPasswordConfig) => Promise<Partial<TestConfig> | null>;
+    /**
+     * load sign up strategies
+     */
+    getSignUpStrategies: () => Promise<TSignupStrategyResponse>;
     /**
      * recover Multi-Factor authentication by providing the recoveryCode
      * that has been received when activated it
@@ -470,6 +474,12 @@ export declare class AuthenticationApi extends BaseApiClient {
      * @param body - The sign-up data
      */
     signUpUser: (body: ISignUpUser) => Promise<ISignUpResponse>;
+    /**
+     * Sign up a new user and create a new tenant.
+     *
+     * @param body - The sign-up data
+     */
+    signUpUserWithPhoneNumber: (body: ISignUpUser) => Promise<ISignUpResponse>;
     /**
      * Get all current user active sessions.
      */

package/auth/index.js

@@ -212,6 +212,9 @@ export class AuthenticationApi extends BaseApiClient {
     this.loadPasswordConfig = async params => {
       return this.get(`${urls.identity.users.v1}/passwords/config`, params);
     };
+    this.getSignUpStrategies = async () => {
+      return this.get(`${urls.identity.signup.v1.strategies}`);
+    };
     this.recoverMfaToken = async body => {
       return this.post(`${urls.identity.auth.v1}/user/mfa/recover`, body);
     };
@@ -452,6 +455,35 @@ export class AuthenticationApi extends BaseApiClient {
         activationToken
       });
     };
+    this.signUpUserWithPhoneNumber = async body => {
+      const {
+        shouldActivate,
+        authResponse,
+        userId,
+        tenantId,
+        activationToken
+      } = await this.post(`${urls.identity.users.v1}/signUp/phoneNumber`, body);
+      const response = {
+        shouldActivate,
+        userId,
+        tenantId
+      };
+      if (!shouldActivate && authResponse) {
+        const {
+          user,
+          tenants,
+          activeTenant
+        } = await this.generateLoginResponseV3(authResponse);
+        return _extends({}, response, {
+          user,
+          tenants,
+          activeTenant
+        });
+      }
+      return _extends({}, response, {
+        activationToken
+      });
+    };
     this.getCurrentUserSessions = async () => {
       return this.get(urls.identity.users.sessions.currentUser.v1);
     };

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, SocialLoginProviders } from './enums';
+import { AuthStrategyEnum, MachineToMachineAuthStrategy, SignUpStrategyEnum, SocialLoginProviders } from './enums';
 import { ISamlRolesGroup } from '../teams/interfaces';
 export * from './secutiry-poilicy/interfaces';
 export type IPreLogin = {
@@ -32,6 +32,7 @@ export type ILogin = {
     invitationToken?: string;
 };
 export type ILoginResponse = IUserProfile & {
+    otcToken?: string;
     mfaRequired: boolean;
     accessToken: string;
     refreshToken: string;
@@ -229,7 +230,7 @@ export interface IVendorConfig {
     machineToMachineAuthStrategy: MachineToMachineAuthStrategy;
 }
 export interface ISignUpUser {
-    email: string;
+    email?: string;
     companyName: string;
     recaptchaToken?: string;
     name?: string;
@@ -707,3 +708,9 @@ export interface IMFAStrategiesResponse {
     strategies: IMFAStrategyResponse[];
 }
 export declare const LOAD_AUTHORIZATION_FF = "admin_portal_should_load_authorization";
+export type TSignupStrategy = {
+    strategy: SignUpStrategyEnum;
+    isActive: boolean;
+    isRequired: boolean;
+};
+export type TSignupStrategyResponse = Array<TSignupStrategy>;

package/constants.d.ts

@@ -1,6 +1,11 @@
 export declare const urls: {
     vendor: string;
     identity: {
+        signup: {
+            v1: {
+                strategies: string;
+            };
+        };
         webAuthnDevices: {
             v1: string;
         };

package/constants.js

@@ -1,6 +1,11 @@
 export const urls = {
   vendor: '/vendors',
   identity: {
+    signup: {
+      v1: {
+        strategies: '/identity/resources/configurations/v1/sign-up/strategies'
+      }
+    },
     webAuthnDevices: {
       v1: '/identity/resources/users/webauthn/v1/devices'
     },

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v7.66.0
+/** @license Frontegg v7.67.0-alpha.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/enums.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.SocialLoginProviders = exports.MachineToMachineAuthStrategy = exports.AuthStrategyEnum = void 0;
+exports.SocialLoginProviders = exports.SignUpStrategyEnum = exports.MachineToMachineAuthStrategy = exports.AuthStrategyEnum = void 0;
 let SocialLoginProviders;
 exports.SocialLoginProviders = SocialLoginProviders;
 (function (SocialLoginProviders) {
@@ -29,4 +29,10 @@ exports.MachineToMachineAuthStrategy = MachineToMachineAuthStrategy;
 (function (MachineToMachineAuthStrategy) {
   MachineToMachineAuthStrategy["ClientCredentials"] = "ClientCredentials";
   MachineToMachineAuthStrategy["AccessToken"] = "AccessToken";
-})(MachineToMachineAuthStrategy || (exports.MachineToMachineAuthStrategy = MachineToMachineAuthStrategy = {}));
+})(MachineToMachineAuthStrategy || (exports.MachineToMachineAuthStrategy = MachineToMachineAuthStrategy = {}));
+let SignUpStrategyEnum;
+exports.SignUpStrategyEnum = SignUpStrategyEnum;
+(function (SignUpStrategyEnum) {
+  SignUpStrategyEnum["Email"] = "email";
+  SignUpStrategyEnum["PhoneNumber"] = "phoneNumber";
+})(SignUpStrategyEnum || (exports.SignUpStrategyEnum = SignUpStrategyEnum = {}));

package/node/auth/index.js

@@ -278,6 +278,9 @@ class AuthenticationApi extends _BaseApiClient.BaseApiClient {
     this.loadPasswordConfig = async params => {
       return this.get(`${_constants2.urls.identity.users.v1}/passwords/config`, params);
     };
+    this.getSignUpStrategies = async () => {
+      return this.get(`${_constants2.urls.identity.signup.v1.strategies}`);
+    };
     this.recoverMfaToken = async body => {
       return this.post(`${_constants2.urls.identity.auth.v1}/user/mfa/recover`, body);
     };
@@ -518,6 +521,35 @@ class AuthenticationApi extends _BaseApiClient.BaseApiClient {
         activationToken
       });
     };
+    this.signUpUserWithPhoneNumber = async body => {
+      const {
+        shouldActivate,
+        authResponse,
+        userId,
+        tenantId,
+        activationToken
+      } = await this.post(`${_constants2.urls.identity.users.v1}/signUp/phoneNumber`, body);
+      const response = {
+        shouldActivate,
+        userId,
+        tenantId
+      };
+      if (!shouldActivate && authResponse) {
+        const {
+          user,
+          tenants,
+          activeTenant
+        } = await this.generateLoginResponseV3(authResponse);
+        return (0, _extends2.default)({}, response, {
+          user,
+          tenants,
+          activeTenant
+        });
+      }
+      return (0, _extends2.default)({}, response, {
+        activationToken
+      });
+    };
     this.getCurrentUserSessions = async () => {
       return this.get(_constants2.urls.identity.users.sessions.currentUser.v1);
     };

package/node/constants.js

@@ -7,6 +7,11 @@ exports.urls = exports.GENERIC_ERROR_MESSAGE = exports.GENERIC_ERROR_CODE = expo
 const urls = {
   vendor: '/vendors',
   identity: {
+    signup: {
+      v1: {
+        strategies: '/identity/resources/configurations/v1/sign-up/strategies'
+      }
+    },
     webAuthnDevices: {
       v1: '/identity/resources/users/webauthn/v1/devices'
     },

package/node/index.js

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