@frontegg/rest-api 3.0.37 → 3.0.39

package/auth/index.d.ts

@@ -1,7 +1,7 @@
 export * from './secutiry-poilicy';
 export * from './enums';
 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 } from './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 } from './interfaces';
 /*****************************************
  * Authentication
  *****************************************/
@@ -145,6 +145,47 @@ export declare function verifyMfa(body: IVerifyMfa): Promise<IVerifyMfaResponse>
  * * ``authorized user``
  */
 export declare function disableMfa(body: IDisableMfa): Promise<void>;
+/**
+ * disable MFA Authenticator App.
+ *
+ * @throws exception if the generated token is incorrect.
+ * * ``authorized user``
+ */
+export declare function disableMFAAuthenticatorApp(deviceId: string, body: IDisableMfa): Promise<void>;
+/**
+ * pre disable MFA SMS, should be called if user has just one mfa device
+ *
+ * @throws exception if pre disable is not required for disable
+ * * ``authorized user``
+ */
+export declare function preDisableMFASMS(deviceId: string): Promise<IPreDisableMFASMSResponse>;
+/**
+ * after pre disable MFA SMS, disable MFA SMS should be called. can also be called without pre disable if
+ * user has more than one mfa device
+ *
+ * @throws exception if pre disable is not required for disable
+ * * ``authorized user``
+ */
+export declare function disableMFASMS(deviceId: string, body: IDisableMFASMS): Promise<void>;
+/**
+ * pre disable MFA WebAuthn, should be called if user has just one mfa device
+ *
+ * @throws exception if pre disable is not required for disable
+ * * ``authorized user``
+ */
+export declare function preDisableMFAWebAuthn(deviceId: string): Promise<IPreDisableMFAWebAuthnResponse>;
+/**
+ * after pre disable MFA WebAuthn, disable MFA WebAuthn should be called. can also be called without pre disable if
+ * user has more than one mfa device
+ *
+ * @throws exception if pre disable is not required for disable
+ * * ``authorized user``
+ */
+export declare function disableMFAWebAuthn(deviceId: string, body: IDisableMFAWebAuthn): Promise<void>;
+/**
+ * returns user mfa devices list splitted into 3 arrays. webauthn, phones and authenticators.
+ */
+export declare function getMFADevices(): Promise<UserMFADevicesResponse>;
 /**
  * pre enroll Multi-Factor Auth Code to use in 3rd party apps like Google Authenticator.
  * the server returns qrCode as png image in base64 format
@@ -165,7 +206,7 @@ export declare function verifyMFAAuthenticatorAppForLogin(deviceId: string, body
  * the server returns otcToken that should be sent to the enroll function with the code that was sent to
  * the request phone number
  */
-export declare function preEnrollMFASMSForLogin(body: IPreEnrollMFASMS): Promise<void>;
+export declare function preEnrollMFASMSForLogin(body: IPreEnrollMFASMS): Promise<IPreEnrollMFASMSResponse>;
 /**
  * after pre enroll with SMS, enroll SMS function should be called
  * with the otcToken and the code that has been sent to the phone number that was requested

package/auth/index.js

@@ -134,6 +134,24 @@ export async function verifyMfa(body) {
 export async function disableMfa(body) {
   return Post(`${urls.identity.users.v1}/mfa/disable`, body);
 }
+export async function disableMFAAuthenticatorApp(deviceId, body) {
+  return Post(`${urls.identity.users.v1}/mfa/authenticator/${deviceId}/disable/verify`, body);
+}
+export async function preDisableMFASMS(deviceId) {
+  return Post(`${urls.identity.users.v1}/mfa/sms/${deviceId}/disable`);
+}
+export async function disableMFASMS(deviceId, body) {
+  return Post(`${urls.identity.users.v1}/mfa/sms/${deviceId}/disable/verify`, body);
+}
+export async function preDisableMFAWebAuthn(deviceId) {
+  return Post(`${urls.identity.users.v1}/mfa/webauthn/${deviceId}/disable`);
+}
+export async function disableMFAWebAuthn(deviceId, body) {
+  return Post(`${urls.identity.users.v1}/mfa/webauthn/${deviceId}/disable/verify`, body);
+}
+export async function getMFADevices() {
+  return Get(`${urls.identity.users.v1}/mfa/devices`);
+}
 export async function preEnrollMFAAuthenticatorAppForLogin(body) {
   return Post(`${urls.identity.auth.v1}/user/mfa/authenticator/enroll`, body);
 }

package/auth/interfaces.d.ts

@@ -1,7 +1,7 @@
-import { ITenantsResponse, IUserProfile } from '..';
+import { ITenantsResponse, IUserProfile } from "..";
 import { AuthStrategyEnum, SocialLoginProviders } from "./enums";
-import { ISamlRolesGroup } from '../teams/interfaces';
-export * from './secutiry-poilicy/interfaces';
+import { ISamlRolesGroup } from "../teams/interfaces";
+export * from "./secutiry-poilicy/interfaces";
 export declare type IPreLogin = {
     email: string;
 };
@@ -11,7 +11,7 @@ export declare type IPostLogin = {
 };
 export declare type IPreLoginWithIdpTypeResponse = {
     address: string;
-    idpType: 'saml' | 'oidc';
+    idpType: "saml" | "oidc";
 };
 export declare type IOidcPostLogin = {
     code: string;
@@ -42,7 +42,7 @@ export declare type ILoginResponse = IUserProfile & {
     redirectLocation?: string;
     userEmail?: string;
     mfaStrategies?: MFAStrategyEnum[];
-    mfaDevices?: UserMFADevicesResponse[];
+    mfaDevices?: UserMFADevicesResponse;
 };
 export declare type ILoginResponseV2 = {
     user: ILoginResponse;
@@ -93,7 +93,7 @@ export declare type IVerifyMfaResponse = {
     recoveryCode: string;
 };
 export declare type IDisableMfa = {
-    token: string;
+    token?: string;
 };
 export declare type ISamlConfiguration = {
     enabled: boolean;
@@ -119,7 +119,7 @@ export declare type IOidcConfiguration = {
 export declare type ISSOPublicConfiguration = {
     isActive: boolean;
 };
-export declare type IUpdateSamlConfiguration = Omit<ISamlConfiguration, 'validated' | 'generatedVerification' | 'createdAt' | 'updatedAt'>;
+export declare type IUpdateSamlConfiguration = Omit<ISamlConfiguration, "validated" | "generatedVerification" | "createdAt" | "updatedAt">;
 export declare type ISamlVendorConfigResponse = {
     acsUrl: string;
     spEntityId: string;
@@ -127,7 +127,7 @@ export declare type ISamlVendorConfigResponse = {
 export declare type ISamlVendorMetadata = {
     id: string;
     vendorId: string;
-    entityName: 'saml';
+    entityName: "saml";
     configuration: ISamlVendorConfigResponse;
 };
 export declare type IUpdateSamlVendorMetadata = {
@@ -345,7 +345,7 @@ export interface IOAuthTokenResponse {
     id_token: string;
     refresh_token: string;
 }
-export declare type IUpdateSSOConfiguration = Partial<Omit<ISSOConfiguration, 'id' | 'createdAt' | 'updatedAt' | 'domains'>>;
+export declare type IUpdateSSOConfiguration = Partial<Omit<ISSOConfiguration, "id" | "createdAt" | "updatedAt" | "domains">>;
 export interface IResetPhoneNumber {
     email: string;
 }
@@ -420,7 +420,7 @@ export interface ICreateNewDeviceSessionResponse {
     };
     challenge: string;
     pubKeyCredParams: Array<{
-        type: 'public-key';
+        type: "public-key";
         alg: number;
     }>;
     excludeCredentials?: AllowCredentials[];
@@ -533,3 +533,19 @@ export interface UserMFADevicesResponse {
     phones: UserMFAPhoneDevice[];
     authenticators: UserMFAAuthenticatorApp[];
 }
+export interface IPreDisableMFASMSResponse {
+    otcToken: string;
+    phoneNumber: string;
+}
+export interface IDisableMFASMS {
+    otcToken?: string;
+    code?: string;
+}
+export interface IPreDisableMFAWebAuthnResponse {
+    webauthnToken: string;
+    options: IWebAuthnPreLoginResponse;
+}
+export interface IDisableMFAWebAuthn {
+    webauthnToken?: string;
+    options?: Omit<IWebAuthnPostLogin, "recaptchaToken" | "invitationToken">;
+}

package/auth/interfaces.js

@@ -1,12 +1,4 @@
-export * from './secutiry-poilicy/interfaces';
-;
-;
-;
-;
-;
-;
-;
-;
+export * from "./secutiry-poilicy/interfaces";
 export let SecondaryAuthStrategy;
 
 (function (SecondaryAuthStrategy) {

package/index.js

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

@@ -30,6 +30,12 @@ var _exportNames = {
   enrollMfa: true,
   verifyMfa: true,
   disableMfa: true,
+  disableMFAAuthenticatorApp: true,
+  preDisableMFASMS: true,
+  disableMFASMS: true,
+  preDisableMFAWebAuthn: true,
+  disableMFAWebAuthn: true,
+  getMFADevices: true,
   preEnrollMFAAuthenticatorAppForLogin: true,
   enrollMFAAuthenticatorAppForLogin: true,
   verifyMFAAuthenticatorAppForLogin: true,
@@ -126,6 +132,9 @@ exports.deleteSamlGroup = deleteSamlGroup;
 exports.deleteSessionForUser = deleteSessionForUser;
 exports.deleteTenantApiToken = deleteTenantApiToken;
 exports.deleteUserApiToken = deleteUserApiToken;
+exports.disableMFAAuthenticatorApp = disableMFAAuthenticatorApp;
+exports.disableMFASMS = disableMFASMS;
+exports.disableMFAWebAuthn = disableMFAWebAuthn;
 exports.disableMfa = disableMfa;
 exports.enrollMFAAuthenticatorAppForLogin = enrollMFAAuthenticatorAppForLogin;
 exports.enrollMFASMSForLogin = enrollMFASMSForLogin;
@@ -139,6 +148,7 @@ exports.generateLoginResponseV2 = generateLoginResponseV2;
 exports.getActivateAccountStrategy = getActivateAccountStrategy;
 exports.getCurrentUserSession = getCurrentUserSession;
 exports.getCurrentUserSessions = getCurrentUserSessions;
+exports.getMFADevices = getMFADevices;
 exports.getOidcConfiguration = getOidcConfiguration;
 exports.getSSOConfigurations = getSSOConfigurations;
 exports.getSSODefaultRoles = getSSODefaultRoles;
@@ -166,6 +176,8 @@ exports.oidcPostLoginV2 = oidcPostLoginV2;
 exports.passwordlessPostLogin = passwordlessPostLogin;
 exports.passwordlessPreLogin = passwordlessPreLogin;
 exports.postLogin = postLogin;
+exports.preDisableMFASMS = preDisableMFASMS;
+exports.preDisableMFAWebAuthn = preDisableMFAWebAuthn;
 exports.preEnrollMFAAuthenticatorAppForLogin = preEnrollMFAAuthenticatorAppForLogin;
 exports.preEnrollMFASMSForLogin = preEnrollMFASMSForLogin;
 exports.preEnrollMFAWebAuthnForLogin = preEnrollMFAWebAuthnForLogin;
@@ -405,6 +417,30 @@ async function disableMfa(body) {
   return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/disable`, body);
 }
 
+async function disableMFAAuthenticatorApp(deviceId, body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/authenticator/${deviceId}/disable/verify`, body);
+}
+
+async function preDisableMFASMS(deviceId) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/sms/${deviceId}/disable`);
+}
+
+async function disableMFASMS(deviceId, body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/sms/${deviceId}/disable/verify`, body);
+}
+
+async function preDisableMFAWebAuthn(deviceId) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/webauthn/${deviceId}/disable`);
+}
+
+async function disableMFAWebAuthn(deviceId, body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/webauthn/${deviceId}/disable/verify`, body);
+}
+
+async function getMFADevices() {
+  return (0, _fetch.Get)(`${_constants.urls.identity.users.v1}/mfa/devices`);
+}
+
 async function preEnrollMFAAuthenticatorAppForLogin(body) {
   return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/authenticator/enroll`, body);
 }

package/node/auth/interfaces.js

@@ -23,14 +23,6 @@ Object.keys(_interfaces).forEach(function (key) {
     }
   });
 });
-;
-;
-;
-;
-;
-;
-;
-;
 let SecondaryAuthStrategy;
 exports.SecondaryAuthStrategy = SecondaryAuthStrategy;
 

package/node/index.js

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

package/teams/interfaces.d.ts

@@ -93,7 +93,7 @@ export declare type ILoadUsers = {
     pageSize?: number;
 };
 export declare type IAddUser = {
-    name: string;
+    name?: string;
     email: string;
     phone?: string;
     roleIds: string[];