@frontegg/rest-api 3.0.34 → 3.0.36

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 } 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 } from './interfaces';
 /*****************************************
  * Authentication
  *****************************************/
@@ -145,6 +145,63 @@ export declare function verifyMfa(body: IVerifyMfa): Promise<IVerifyMfaResponse>
  * * ``authorized user``
  */
 export declare function disableMfa(body: IDisableMfa): Promise<void>;
+/**
+ * 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
+ */
+export declare function preEnrollMFAAuthenticatorAppForLogin(body: IPreEnrollMFA): Promise<IPreEnrollMFAAuthenticatorAppResponse>;
+/**
+ * after pre enroll with authenticator app, enroll authenticator app function should be called
+ * with the generated code in the Authenticator App
+ */
+export declare function enrollMFAAuthenticatorAppForLogin(body: IEnrollMFAAuthenticatorApp): Promise<ILoginResponse>;
+/**
+  * after login succeeded with mfaRequired token response, this function should be called
+  * with the selected authenticator app id, mfaToken and the generated code from your authenticator app.
+ */
+export declare function verifyMFAAuthenticatorAppForLogin(deviceId: string, body: IVerifyMFAAuthenticatorApp): Promise<ILoginResponse>;
+/**
+ * pre enroll Multi-Factor to use with SMS
+ * 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>;
+/**
+ * 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
+ */
+export declare function enrollMFASMSForLogin(body: IEnrollMFASMS): Promise<ILoginResponse>;
+/**
+  * after login succeeded with mfaRequired token response, if the user asked to use SMS as MFA
+  * this function should be called with the selected device id and mfaToken
+ */
+export declare function preVerifyMFASMSForLogin(deviceId: string, body: IPreVerifyMFA): Promise<IPreVerifyMFASMSResponse>;
+/**
+  * after pre verify with SMS, this function should be called with otcToken, mfaToken and the code
+  * that has been sent to the selected device.
+ */
+export declare function verifyMFASMSForLogin(deviceId: string, body: IVerifyMFASMS): Promise<ILoginResponse>;
+/**
+ * pre enroll Multi-Factor to use with WebAuthn
+ * the server returns attestation object
+ * the request phone number
+ */
+export declare function preEnrollMFAWebAuthnForLogin(body: IPreEnrollMFA): Promise<IPreEnrollMFAWebAuthnResponse>;
+/**
+ * after pre enroll with WebAuthn, enroll WebAuthn function should be called
+ * with the webauthnToken and the attestation object response
+ */
+export declare function enrollMFAWebAuthnForLogin(body: IEnrollMFAWebAuthn): Promise<ILoginResponse>;
+/**
+  * after login succeeded with mfaRequired token response, if the user asked to use WebAuthn as MFA
+  * this function should be called with the selected device id and mfaToken.
+ */
+export declare function preVerifyMFAWebAuthnForLogin(deviceId: string, body: IPreVerifyMFA): Promise<IPreVerifyMFAWebAuthnResponse>;
+/**
+  * after pre verify with WebAuthn, this function should be called with webauthnTokenToken, mfaToken
+  * and the assertion response.
+ */
+export declare function verifyMFAWebAuthnForLogin(deviceId: string, body: IVerifyMFAWebAuthn): Promise<ILoginResponse>;
 /**
  * SSO Configurations
  */

package/auth/index.js

@@ -134,6 +134,39 @@ export async function verifyMfa(body) {
 export async function disableMfa(body) {
   return Post(`${urls.identity.users.v1}/mfa/disable`, body);
 }
+export async function preEnrollMFAAuthenticatorAppForLogin(body) {
+  return Post(`${urls.identity.auth.v1}/user/mfa/authenticator/enroll`, body);
+}
+export async function enrollMFAAuthenticatorAppForLogin(body) {
+  return Post(`${urls.identity.auth.v1}/user/mfa/authenticator/enroll/verify`, body);
+}
+export async function verifyMFAAuthenticatorAppForLogin(deviceId, body) {
+  return Post(`${urls.identity.auth.v1}/user/mfa/authenticator/${deviceId}/verify`, body);
+}
+export async function preEnrollMFASMSForLogin(body) {
+  return Post(`${urls.identity.auth.v1}/user/mfa/sms/enroll`, body);
+}
+export async function enrollMFASMSForLogin(body) {
+  return Post(`${urls.identity.auth.v1}/user/mfa/sms/enroll/verify`, body);
+}
+export async function preVerifyMFASMSForLogin(deviceId, body) {
+  return Post(`${urls.identity.auth.v1}/user/mfa/sms/${deviceId}`, body);
+}
+export async function verifyMFASMSForLogin(deviceId, body) {
+  return Post(`${urls.identity.auth.v1}/user/mfa/sms/${deviceId}/verify`, body);
+}
+export async function preEnrollMFAWebAuthnForLogin(body) {
+  return Post(`${urls.identity.auth.v1}/user/mfa/webauthn/enroll`, body);
+}
+export async function enrollMFAWebAuthnForLogin(body) {
+  return Post(`${urls.identity.auth.v1}/user/mfa/webauthn/enroll/verify`, body);
+}
+export async function preVerifyMFAWebAuthnForLogin(deviceId, body) {
+  return Post(`${urls.identity.auth.v1}/user/mfa/webauthn/${deviceId}`, body);
+}
+export async function verifyMFAWebAuthnForLogin(deviceId, body) {
+  return Post(`${urls.identity.auth.v1}/user/mfa/webauthn/${deviceId}/verify`, body);
+}
 export async function getSamlConfiguration() {
   return Get(`${urls.team.sso.v1}/saml/configurations`);
 }

package/auth/interfaces.d.ts

@@ -41,6 +41,8 @@ export declare type ILoginResponse = IUserProfile & {
     emailVerified?: boolean;
     redirectLocation?: string;
     userEmail?: string;
+    mfaStrategies?: MFAStrategyEnum[];
+    mfaDevices?: UserMFADevicesResponse[];
 };
 export declare type ILoginResponseV2 = {
     user: ILoginResponse;
@@ -445,3 +447,89 @@ export interface IAuthStrategyConfig {
 export interface IAuthStrategiesConfig {
     secondaryAuthStrategies: IAuthStrategyConfig[];
 }
+export interface IPreEnrollMFA {
+    mfaToken: string;
+}
+export interface IEnrollMFA {
+    mfaToken: string;
+    rememberDevice?: boolean;
+}
+export interface IPreEnrollMFAAuthenticatorAppResponse {
+    qrCode: string;
+}
+export interface IEnrollMFAAuthenticatorApp extends IEnrollMFA {
+    token: string;
+}
+export interface IPreEnrollMFASMS extends IPreEnrollMFA {
+    phoneNumber: string;
+}
+export interface IPreEnrollMFASMSResponse {
+    otcToken: string;
+    phoneNumber: string;
+}
+export interface IEnrollMFASMS extends IEnrollMFA {
+    otcToken: string;
+    code: string;
+}
+export declare enum WebAuthnDeviceType {
+    Android = "Android",
+    USBKey = "USBKey",
+    TouchID = "TouchID"
+}
+export interface IEnrollMFAWebAuthn extends IEnrollMFA {
+    deviceType: WebAuthnDeviceType;
+    webauthnToken: string;
+    options: IVerifyNewWebAuthnDevice;
+}
+export interface IPreEnrollMFAWebAuthnResponse {
+    webauthnToken: string;
+    options: ICreateNewDeviceSessionResponse;
+}
+export interface IPreVerifyMFA {
+    mfaToken: string;
+}
+export interface IVerifyMFA {
+    mfaToken: string;
+    rememberDevice?: boolean;
+}
+export interface IVerifyMFAAuthenticatorApp extends IVerifyMFA {
+    value: string;
+}
+export interface IPreVerifyMFASMSResponse {
+    otcToken: string;
+    phoneNumber: string;
+}
+export interface IVerifyMFASMS extends IVerifyMFA {
+    otcToken: string;
+    code: string;
+}
+export interface IPreVerifyMFAWebAuthnResponse {
+    webauthnToken: string;
+    options: IWebAuthnPreLoginResponse;
+}
+export interface IVerifyMFAWebAuthn extends IVerifyMFA {
+    webauthnToken: string;
+    options: Omit<IWebAuthnPostLogin, "recaptchaToken" | "invitationToken">;
+}
+export declare enum MFAStrategyEnum {
+    AuthenticatorApp = "AuthenticatorApp",
+    WebAuthn = "WebAuthn",
+    SMS = "SMS"
+}
+export interface UserMFAWebAuthnDevice {
+    id: string;
+    deviceType: WebAuthnDeviceType;
+    name: string;
+}
+export interface UserMFAPhoneDevice {
+    id: string;
+    phoneNumber: string;
+}
+export interface UserMFAAuthenticatorApp {
+    id: string;
+}
+export interface UserMFADevicesResponse {
+    webauthn: UserMFAWebAuthnDevice[];
+    phones: UserMFAPhoneDevice[];
+    authenticators: UserMFAAuthenticatorApp[];
+}

package/auth/interfaces.js

@@ -13,4 +13,20 @@ export let SecondaryAuthStrategy;
   SecondaryAuthStrategy["WebAuthnPlatform"] = "WebAuthnPlatform";
   SecondaryAuthStrategy["WebAuthnCrossPlatform"] = "WebAuthnCrossPlatform";
   SecondaryAuthStrategy["SmsCode"] = "SmsCode";
-})(SecondaryAuthStrategy || (SecondaryAuthStrategy = {}));
+})(SecondaryAuthStrategy || (SecondaryAuthStrategy = {}));
+
+export let WebAuthnDeviceType;
+
+(function (WebAuthnDeviceType) {
+  WebAuthnDeviceType["Android"] = "Android";
+  WebAuthnDeviceType["USBKey"] = "USBKey";
+  WebAuthnDeviceType["TouchID"] = "TouchID";
+})(WebAuthnDeviceType || (WebAuthnDeviceType = {}));
+
+export let MFAStrategyEnum;
+
+(function (MFAStrategyEnum) {
+  MFAStrategyEnum["AuthenticatorApp"] = "AuthenticatorApp";
+  MFAStrategyEnum["WebAuthn"] = "WebAuthn";
+  MFAStrategyEnum["SMS"] = "SMS";
+})(MFAStrategyEnum || (MFAStrategyEnum = {}));

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.34
+/** @license Frontegg v3.0.36
  *
  * 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,17 @@ var _exportNames = {
   enrollMfa: true,
   verifyMfa: true,
   disableMfa: true,
+  preEnrollMFAAuthenticatorAppForLogin: true,
+  enrollMFAAuthenticatorAppForLogin: true,
+  verifyMFAAuthenticatorAppForLogin: true,
+  preEnrollMFASMSForLogin: true,
+  enrollMFASMSForLogin: true,
+  preVerifyMFASMSForLogin: true,
+  verifyMFASMSForLogin: true,
+  preEnrollMFAWebAuthnForLogin: true,
+  enrollMFAWebAuthnForLogin: true,
+  preVerifyMFAWebAuthnForLogin: true,
+  verifyMFAWebAuthnForLogin: true,
   getSamlConfiguration: true,
   updateSamlConfiguration: true,
   getSamlVendorConfiguration: true,
@@ -116,6 +127,9 @@ exports.deleteSessionForUser = deleteSessionForUser;
 exports.deleteTenantApiToken = deleteTenantApiToken;
 exports.deleteUserApiToken = deleteUserApiToken;
 exports.disableMfa = disableMfa;
+exports.enrollMFAAuthenticatorAppForLogin = enrollMFAAuthenticatorAppForLogin;
+exports.enrollMFASMSForLogin = enrollMFASMSForLogin;
+exports.enrollMFAWebAuthnForLogin = enrollMFAWebAuthnForLogin;
 exports.enrollMfa = enrollMfa;
 exports.exchangeOAuthTokens = exchangeOAuthTokens;
 exports.forgotPassword = forgotPassword;
@@ -152,9 +166,14 @@ exports.oidcPostLoginV2 = oidcPostLoginV2;
 exports.passwordlessPostLogin = passwordlessPostLogin;
 exports.passwordlessPreLogin = passwordlessPreLogin;
 exports.postLogin = postLogin;
+exports.preEnrollMFAAuthenticatorAppForLogin = preEnrollMFAAuthenticatorAppForLogin;
+exports.preEnrollMFASMSForLogin = preEnrollMFASMSForLogin;
+exports.preEnrollMFAWebAuthnForLogin = preEnrollMFAWebAuthnForLogin;
 exports.preLogin = preLogin;
 exports.preLoginV2 = preLoginV2;
 exports.preLoginWithIdpType = preLoginWithIdpType;
+exports.preVerifyMFASMSForLogin = preVerifyMFASMSForLogin;
+exports.preVerifyMFAWebAuthnForLogin = preVerifyMFAWebAuthnForLogin;
 exports.recoverMfaToken = recoverMfaToken;
 exports.refreshToken = refreshToken;
 exports.refreshTokenV2 = refreshTokenV2;
@@ -179,6 +198,9 @@ exports.validateSSODomain = validateSSODomain;
 exports.validateSamlDomain = validateSamlDomain;
 exports.verifyChangePhoneNumber = verifyChangePhoneNumber;
 exports.verifyInviteToken = verifyInviteToken;
+exports.verifyMFAAuthenticatorAppForLogin = verifyMFAAuthenticatorAppForLogin;
+exports.verifyMFASMSForLogin = verifyMFASMSForLogin;
+exports.verifyMFAWebAuthnForLogin = verifyMFAWebAuthnForLogin;
 exports.verifyMfa = verifyMfa;
 exports.verifyNewDeviceSession = verifyNewDeviceSession;
 exports.verifyResetPhoneNumber = verifyResetPhoneNumber;
@@ -383,6 +405,50 @@ async function disableMfa(body) {
   return (0, _fetch.Post)(`${_constants.urls.identity.users.v1}/mfa/disable`, body);
 }
 
+async function preEnrollMFAAuthenticatorAppForLogin(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/authenticator/enroll`, body);
+}
+
+async function enrollMFAAuthenticatorAppForLogin(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/authenticator/enroll/verify`, body);
+}
+
+async function verifyMFAAuthenticatorAppForLogin(deviceId, body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/authenticator/${deviceId}/verify`, body);
+}
+
+async function preEnrollMFASMSForLogin(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/sms/enroll`, body);
+}
+
+async function enrollMFASMSForLogin(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/sms/enroll/verify`, body);
+}
+
+async function preVerifyMFASMSForLogin(deviceId, body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/sms/${deviceId}`, body);
+}
+
+async function verifyMFASMSForLogin(deviceId, body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/sms/${deviceId}/verify`, body);
+}
+
+async function preEnrollMFAWebAuthnForLogin(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/webauthn/enroll`, body);
+}
+
+async function enrollMFAWebAuthnForLogin(body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/webauthn/enroll/verify`, body);
+}
+
+async function preVerifyMFAWebAuthnForLogin(deviceId, body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/webauthn/${deviceId}`, body);
+}
+
+async function verifyMFAWebAuthnForLogin(deviceId, body) {
+  return (0, _fetch.Post)(`${_constants.urls.identity.auth.v1}/user/mfa/webauthn/${deviceId}/verify`, body);
+}
+
 async function getSamlConfiguration() {
   return (0, _fetch.Get)(`${_constants.urls.team.sso.v1}/saml/configurations`);
 }

package/node/auth/interfaces.js

@@ -4,9 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 var _exportNames = {
-  SecondaryAuthStrategy: true
+  SecondaryAuthStrategy: true,
+  WebAuthnDeviceType: true,
+  MFAStrategyEnum: true
 };
-exports.SecondaryAuthStrategy = void 0;
+exports.WebAuthnDeviceType = exports.SecondaryAuthStrategy = exports.MFAStrategyEnum = void 0;
 
 var _interfaces = require("./secutiry-poilicy/interfaces");
 
@@ -36,4 +38,22 @@ exports.SecondaryAuthStrategy = SecondaryAuthStrategy;
   SecondaryAuthStrategy["WebAuthnPlatform"] = "WebAuthnPlatform";
   SecondaryAuthStrategy["WebAuthnCrossPlatform"] = "WebAuthnCrossPlatform";
   SecondaryAuthStrategy["SmsCode"] = "SmsCode";
-})(SecondaryAuthStrategy || (exports.SecondaryAuthStrategy = SecondaryAuthStrategy = {}));
+})(SecondaryAuthStrategy || (exports.SecondaryAuthStrategy = SecondaryAuthStrategy = {}));
+
+let WebAuthnDeviceType;
+exports.WebAuthnDeviceType = WebAuthnDeviceType;
+
+(function (WebAuthnDeviceType) {
+  WebAuthnDeviceType["Android"] = "Android";
+  WebAuthnDeviceType["USBKey"] = "USBKey";
+  WebAuthnDeviceType["TouchID"] = "TouchID";
+})(WebAuthnDeviceType || (exports.WebAuthnDeviceType = WebAuthnDeviceType = {}));
+
+let MFAStrategyEnum;
+exports.MFAStrategyEnum = MFAStrategyEnum;
+
+(function (MFAStrategyEnum) {
+  MFAStrategyEnum["AuthenticatorApp"] = "AuthenticatorApp";
+  MFAStrategyEnum["WebAuthn"] = "WebAuthn";
+  MFAStrategyEnum["SMS"] = "SMS";
+})(MFAStrategyEnum || (exports.MFAStrategyEnum = MFAStrategyEnum = {}));

package/node/index.js

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