@frontegg/rest-api 3.2.1 → 3.2.2

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, 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, 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 } from './interfaces';
 import { IGetUserAuthorizationResponse, IUserProfile } from "../users/interfaces";
 import { BaseApiClient } from '../BaseApiClient';
 import { SecurityPolicyApi } from './secutiry-poilicy';
@@ -87,6 +87,12 @@ export declare class AuthenticationApi extends BaseApiClient {
      * @throws exception if activation failed
      */
     activateAccountV2: (body: IActivateAccount) => Promise<ILoginResponseV3>;
+    /**
+     * activating account should be called after registering new user or deactivating account
+     * ``activateAccount`` should contains userId, code and the token that has been sent to the user after activation requested.
+     * @throws exception if activation failed
+     */
+    activateAccountWithOTC: (body: IActivateAccountWithOTC) => Promise<ILoginResponseV3>;
     /**
      * get account activation configuration.
      */
@@ -104,11 +110,17 @@ export declare class AuthenticationApi extends BaseApiClient {
      */
     resendInvitationEmail: (body: IResendInvitationEmail) => Promise<void>;
     /**
-     * activating account should be called after registering new user or deactivating account
-     * ``activateAccount`` should contains userId and the token that has been sent to the user after activation requested.
-     * @throws exception if activation failed
+     * accepting invitation should be called after inviting user to new account
+     * ``acceptInvitation`` should contains userId and the token that has been sent to the user after invitation requested.
+     * @throws exception if accept invitation failed
      */
     acceptInvitation: (body: IAcceptInvitation) => Promise<void>;
+    /**
+     * accepting invitation should be called after inviting user to new account
+     * ``acceptInvitation`` should contains userId, code and the token that has been sent to the user after invitation requested.
+     * @throws exception if accept invitation failed
+     */
+    acceptInvitationWithOTC: (body: IAcceptInvitationWithOTC) => Promise<void>;
     /**
      * refresh token called as authenticated use, access and refresh tokens resolved by the cookies.
      * the server will return ILoginResponse with new access Token and refresh token and store it in the browser cookies.

package/auth/index.js

@@ -190,6 +190,11 @@ export class AuthenticationApi extends BaseApiClient {
       return this.generateLoginResponseV3(data);
     };
 
+    this.activateAccountWithOTC = async body => {
+      const data = await this.post(`${urls.identity.users.v1}/activate/code`, body);
+      return this.generateLoginResponseV3(data);
+    };
+
     this.getActivateAccountStrategy = async params => {
       return this.get(`${urls.identity.users.v1}/activate/strategy`, params);
     };
@@ -206,6 +211,10 @@ export class AuthenticationApi extends BaseApiClient {
       return this.post(`${urls.identity.users.v1}/invitation/accept`, body);
     };
 
+    this.acceptInvitationWithOTC = async body => {
+      return this.post(`${urls.identity.users.v1}/invitation/accept/code`, body);
+    };
+
     this.refreshToken = async () => {
       const tabTenantId = getTabTenantFromSessionStorage(this.appName);
       const data = await this.post(`${urls.identity.auth.v1}/user/token/refresh`, {
@@ -502,6 +511,10 @@ export class AuthenticationApi extends BaseApiClient {
         queryParams.code_verifier = params.codeVerifier;
       }
 
+      if (params.codeVerifierPkce) {
+        queryParams.code_verifier_pkce = params.codeVerifierPkce;
+      }
+
       if (params.state) {
         queryParams.state = params.state;
       }

package/auth/interfaces.d.ts

@@ -77,10 +77,16 @@ export declare type IActivateAccount = {
     recaptchaToken?: string;
     lastTermsCheck?: string;
 };
+export declare type IActivateAccountWithOTC = {
+    code: string;
+} & IActivateAccount;
 export declare type IAcceptInvitation = {
     userId: string;
     token: string;
 };
+export declare type IAcceptInvitationWithOTC = IAcceptInvitation & {
+    code: string;
+};
 export declare type IResendActivationEmail = {
     email: string;
 };
@@ -192,6 +198,7 @@ export interface ILoginViaSocialLogin {
     provider: SocialLoginProviders;
     afterAuthRedirectUrl?: string;
     codeVerifier?: string;
+    codeVerifierPkce?: string;
     metadata?: string;
     invitationToken?: string;
     state?: string;

package/index.js

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

@@ -273,6 +273,11 @@ class AuthenticationApi extends _BaseApiClient.BaseApiClient {
       return this.generateLoginResponseV3(data);
     };
 
+    this.activateAccountWithOTC = async body => {
+      const data = await this.post(`${_constants2.urls.identity.users.v1}/activate/code`, body);
+      return this.generateLoginResponseV3(data);
+    };
+
     this.getActivateAccountStrategy = async params => {
       return this.get(`${_constants2.urls.identity.users.v1}/activate/strategy`, params);
     };
@@ -289,6 +294,10 @@ class AuthenticationApi extends _BaseApiClient.BaseApiClient {
       return this.post(`${_constants2.urls.identity.users.v1}/invitation/accept`, body);
     };
 
+    this.acceptInvitationWithOTC = async body => {
+      return this.post(`${_constants2.urls.identity.users.v1}/invitation/accept/code`, body);
+    };
+
     this.refreshToken = async () => {
       const tabTenantId = (0, _utils.getTabTenantFromSessionStorage)(this.appName);
       const data = await this.post(`${_constants2.urls.identity.auth.v1}/user/token/refresh`, {
@@ -585,6 +594,10 @@ class AuthenticationApi extends _BaseApiClient.BaseApiClient {
         queryParams.code_verifier = params.codeVerifier;
       }
 
+      if (params.codeVerifierPkce) {
+        queryParams.code_verifier_pkce = params.codeVerifierPkce;
+      }
+
       if (params.state) {
         queryParams.state = params.state;
       }

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.2.1
+/** @license Frontegg v3.2.2
  *
  * 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.2.1",
+  "version": "3.2.2",
   "main": "./node/index.js",
   "license": "MIT",
   "dependencies": {