@frontegg/rest-api 6.0.1-alpha.4 → 7.28.0-alpha.0

package/auth/interfaces.d.ts

@@ -1,94 +1,123 @@
+import { UserEntitlementsContext as UserEntitlementsResponseV2 } from '@frontegg/entitlements-javascript-commons';
 import { ITenantsResponse, IUserProfile } from '..';
-import { AuthStrategyEnum, SocialLoginProviders } from "./enums";
+import { AuthStrategyEnum, MachineToMachineAuthStrategy, SocialLoginProviders } from './enums';
 import { ISamlRolesGroup } from '../teams/interfaces';
 export * from './secutiry-poilicy/interfaces';
-export declare type IPreLogin = {
+export type IPreLogin = {
     email: string;
+    tenantId?: string;
 };
-export declare type IPostLogin = {
+export type IPostLogin = {
     RelayState: string;
     SAMLResponse: string;
 };
-export declare type IPreLoginWithIdpTypeResponse = {
+export type IPreLoginWithIdpTypeResponse = {
     address: string;
     idpType: 'saml' | 'oidc';
 };
-export declare type IOidcPostLogin = {
+export type IOidcPostLogin = {
     code: string;
     state: string;
     redirectUri?: string;
 };
-export declare type IOidcPostLoginV2 = {
+export type IOidcPostLoginV2 = {
     code: string;
     RelayState: string;
     redirectUri?: string;
 };
-export declare type ILogin = {
+export type ILogin = {
     email: string;
     password: string;
     recaptchaToken?: string;
     invitationToken?: string;
 };
-export declare type ILoginResponse = IUserProfile & {
+export type ILoginResponse = IUserProfile & {
     mfaRequired: boolean;
     accessToken: string;
     refreshToken: string;
+    /**
+     * @deprecated use exp instead
+     */
     expires: string;
+    exp: number;
     expiresIn: number;
     mfaToken?: string;
     qrCode?: string;
     recoveryCode?: string;
     emailVerified?: boolean;
     redirectLocation?: string;
+    userEmail?: string;
+    mfaStrategies?: MFAStrategyEnum[];
+    mfaDevices?: UserMFADevicesResponse;
+    isBreachedPassword?: boolean;
+    entitlements?: UserEntitlementsResponseV2;
+    amr?: string[];
+    acr?: string;
+    auth_time?: number;
 };
-export declare type ILoginResponseV2 = {
+export type ILoginResponseV2 = {
     user: ILoginResponse;
     tenants?: ITenantsResponse[];
 };
-export declare type ILoginWithMfa = {
+export type ILoginResponseV3 = {
+    user: ILoginResponse;
+    tenants?: ITenantsResponse[];
+    activeTenant?: ITenantsResponse;
+};
+export type ILoginWithMfa = {
     mfaToken: string;
     value: string;
     rememberDevice?: boolean;
     invitationToken?: string;
 };
-export declare type IActivateAccount = {
+export type IActivateAccount = {
     userId: string;
     token: string;
     password?: string;
     recaptchaToken?: string;
+    lastTermsCheck?: string;
 };
-export declare type IAcceptInvitation = {
+export type IActivateAccountWithOTC = {
+    code: string;
+} & IActivateAccount;
+export type IAcceptInvitation = {
     userId: string;
     token: string;
 };
-export declare type IResendActivationEmail = {
+export type IAcceptInvitationWithOTC = IAcceptInvitation & {
+    code: string;
+};
+export type IResendActivationEmail = {
+    email: string;
+};
+export type IResendInvitationEmail = {
     email: string;
 };
-export declare type IForgotPassword = {
+export type IForgotPassword = {
     email: string;
 };
-export declare type IResetPassword = {
+export type IResetPassword = {
     token: string;
     userId: string;
     password: string;
 };
-export declare type IRecoverMFAToken = {
+export type IRecoverMFAToken = {
     email: string;
     recoveryCode: string;
 };
-export declare type IEnrollMfaResponse = {
+export type IEnrollMfaResponse = {
     qrCode: string;
 };
-export declare type IVerifyMfa = {
+export type IVerifyMfa = {
     token: string;
 };
-export declare type IVerifyMfaResponse = {
+export type IVerifyMfaResponse = {
     recoveryCode: string;
 };
-export declare type IDisableMfa = {
-    token: string;
+export type IDisableMfa = {
+    token?: string;
 };
-export declare type ISamlConfiguration = {
+export type ISamlConfiguration = {
     enabled: boolean;
     domain?: string;
     validated?: boolean;
@@ -105,27 +134,31 @@ export declare type ISamlConfiguration = {
     oidcSecret?: string;
     type?: string;
 };
-export declare type IOidcConfiguration = {
+export type IOidcConfiguration = {
     active: boolean;
     redirectUri?: string;
 };
-export declare type ISSOPublicConfiguration = {
+export type ISSOPublicConfiguration = {
     isActive: boolean;
 };
-export declare type IUpdateSamlConfiguration = Omit<ISamlConfiguration, 'validated' | 'generatedVerification' | 'createdAt' | 'updatedAt'>;
-export declare type ISamlVendorConfigResponse = {
+export type IUpdateSamlConfiguration = Omit<ISamlConfiguration, 'validated' | 'generatedVerification' | 'createdAt' | 'updatedAt'>;
+export type ISamlVendorConfigResponse = {
     acsUrl: string;
     spEntityId: string;
 };
-export declare type ISamlVendorMetadata = {
+export type ISamlVendorMetadata = {
     id: string;
     vendorId: string;
     entityName: 'saml';
     configuration: ISamlVendorConfigResponse;
 };
-export declare type IUpdateSamlVendorMetadata = {
+export type IUpdateSamlVendorMetadata = {
     metadata: string;
 };
+export interface ICreateOrUpdateSSOConfigurationByMetadataUrl {
+    url: string;
+    configMetadata?: Record<string, string>;
+}
 export interface ISocialLoginProviderConfiguration {
     type: SocialLoginProviders;
     clientId: string;
@@ -136,16 +169,36 @@ export interface ISocialLoginProviderConfigurationV2 {
     type: SocialLoginProviders;
     clientId?: string | null;
     redirectUrl: string;
+    backendRedirectUrl?: string;
     active: boolean;
     authorizationUrl?: string | null;
+    options?: Record<string, unknown>;
     customised: boolean;
+    additionalScopes?: string[];
+}
+export interface ICustomSocialLoginProviderConfigurationV1 {
+    providers: {
+        id: string;
+        type: string;
+        clientId: string;
+        redirectUrl: string;
+        redirectUrlPattern: string;
+        authorizationUrl: string;
+        userInfoUrl: string;
+        scopes: string;
+        ssoLogoUrl: string | null;
+        displayName: string;
+        active: boolean;
+    }[];
 }
 export interface ILoginViaSocialLogin {
-    code: string;
+    code?: string;
+    idToken?: string;
     redirectUri?: string;
     provider: SocialLoginProviders;
     afterAuthRedirectUrl?: string;
     codeVerifier?: string;
+    codeVerifierPkce?: string;
     metadata?: string;
     invitationToken?: string;
     state?: string;
@@ -158,6 +211,7 @@ export interface ILoginViaSocialLoginResponse {
     name: string;
     accessToken: string;
     mfaRequired: boolean;
+    userEmail?: string;
 }
 export interface ISetSocialLoginError {
     error: string;
@@ -168,6 +222,7 @@ export interface IVendorConfig {
     apiTokensEnabled: boolean;
     forcePermissions: boolean;
     authStrategy: AuthStrategyEnum;
+    machineToMachineAuthStrategy: MachineToMachineAuthStrategy;
 }
 export interface ISignUpUser {
     email: string;
@@ -185,6 +240,14 @@ export interface ISignUpResponse {
     user?: ILoginResponse;
     userId?: string;
     tenantId?: string;
+    tenants?: ITenantsResponse[];
+    activeTenant?: ITenantsResponse;
+}
+export interface ISignUpApiResponse {
+    shouldActivate: boolean;
+    userId?: string;
+    tenantId?: string;
+    authResponse: ILoginResponse;
 }
 export interface ISessionResponse {
     id: string;
@@ -193,12 +256,31 @@ export interface ISessionResponse {
     userAgent?: string;
     createdAt?: Date;
     current?: boolean;
+    impersonated?: boolean;
+}
+export interface ISessionIdleTimeoutConfiguration {
+    isActive: boolean;
+    timeout: number;
+}
+export interface ISessionTimeoutConfiguration {
+    isActive: boolean;
+    timeout: number;
+}
+export interface ISessionConcurrentConfiguration {
+    isActive: boolean;
+    maxSessions: number;
+}
+export interface ISessionConfigurations {
+    sessionTimeoutConfiguration?: ISessionTimeoutConfiguration;
+    sessionIdleTimeoutConfiguration?: ISessionIdleTimeoutConfiguration;
+    sessionConcurrentConfiguration?: ISessionConcurrentConfiguration;
 }
 export interface IUserApiTokensData {
     clientId?: string;
     description: string;
     metadata?: any;
     secret?: string;
+    expires?: Date;
 }
 export interface ITenantApiTokensData {
     clientId?: string;
@@ -208,17 +290,53 @@ export interface ITenantApiTokensData {
     metadata?: any;
     secret?: string;
     roleIds?: string[];
+    expires?: Date;
 }
 export interface IUpdateUserApiTokensData {
     description: string;
+    expiresInMinutes: number | null;
 }
 export interface IUpdateTenantApiTokensData {
     description: string;
     roleIds: string[];
+    expiresInMinutes: number | null;
 }
 export interface IDeleteApiToken {
     tokenId: string;
 }
+export interface IAccessTokensData {
+    id: string;
+    description?: string;
+    createdAt: Date;
+    secret?: string;
+    expires?: Date;
+}
+export interface IUserAccessTokenData extends IAccessTokensData {
+}
+export interface ITenantAccessTokenData extends IAccessTokensData {
+    roleIds: string[];
+}
+export interface IGetUserAccessTokens {
+    accessTokens: IUserAccessTokenData[];
+}
+export interface IGetTenantAccessTokens {
+    accessTokens: ITenantAccessTokenData[];
+}
+export interface IGetUserAccessTokensData {
+    accessTokens: IUserAccessTokenData[];
+}
+export interface ICreateAccessTokensData {
+    description: string;
+    expiresInMinutes: number | null;
+}
+export interface ICreateUserAccessTokenData extends ICreateAccessTokensData {
+}
+export interface ICreateTenantAccessTokenData extends ICreateAccessTokensData {
+    roleIds: string[];
+}
+export interface IDeleteAccessToken {
+    id: string;
+}
 export interface IUpdateSamlRoles {
     roleIds: string[];
 }
@@ -231,7 +349,7 @@ export interface ICreateSamlGroup {
     group: string;
     roleIds?: string[];
 }
-export declare type IGetUserById = {
+export type IGetUserById = {
     userId: string;
 };
 export interface IUserIdResponse {
@@ -258,12 +376,21 @@ export interface IAllowedToRememberMfaDevice {
     isAllowedToRemember: boolean;
     mfaDeviceExpiration: number;
 }
-export interface IPasswordlessPreLogin {
-    email: string;
+export interface IBasePasswordlessPreLogin {
     recaptchaToken?: string;
     type: AuthStrategyEnum;
     invitationToken?: string;
 }
+export interface IEmailPasswordlessPreLogin extends IBasePasswordlessPreLogin {
+    email: string;
+}
+export interface IUserIDPasswordlessPreLogin extends IBasePasswordlessPreLogin {
+    userId: string;
+}
+export interface IPhoneNumberPasswordlessPreLogin extends IBasePasswordlessPreLogin {
+    phoneNumber: string;
+}
+export type IPasswordlessPreLogin = IEmailPasswordlessPreLogin | IUserIDPasswordlessPreLogin | IPhoneNumberPasswordlessPreLogin;
 export interface IPasswordlessPostLogin {
     token: string;
     recaptchaToken?: string;
@@ -280,6 +407,7 @@ export interface ISSODomain {
     id: string;
     domain: string;
     validated: boolean;
+    txtRecord: string;
 }
 export interface ISSOConfigurationDefaultRoles {
     roleIds: string[];
@@ -301,11 +429,13 @@ export interface ISSOConfiguration {
     domains: ISSODomain[];
     roleIds: string[];
     groups: ISamlRolesGroup[];
+    skipEmailDomainValidation: boolean;
 }
 export interface IExchangeOAuthTokens {
-    code: string;
-    redirect_uri: string;
-    code_verifier: string;
+    code?: string;
+    code_verifier?: string;
+    redirect_uri?: string;
+    refresh_token?: string;
 }
 export interface IOAuthTokenResponse {
     access_token: string;
@@ -313,13 +443,28 @@ export interface IOAuthTokenResponse {
     id_token: string;
     refresh_token: string;
 }
-export declare type IUpdateSSOConfiguration = Partial<Omit<ISSOConfiguration, 'id' | 'createdAt' | 'updatedAt' | 'domains'>>;
+export interface IOAuthLogout {
+    id_token_hint?: string;
+    post_logout_redirect_uri?: string;
+    state?: string;
+}
+export type IUpdateSSOConfiguration = Partial<Omit<ISSOConfiguration, 'id' | 'createdAt' | 'updatedAt' | 'domains'>>;
 export interface IResetPhoneNumber {
     email: string;
 }
 export interface IResetPhoneNumberResponse {
     resetPhoneNumberToken: string;
 }
+export interface IChangePhoneNumberWithVerification {
+    phoneNumber: string;
+}
+export interface IChangePhoneNumberWithVerificationResponse {
+    changePhoneId: string;
+}
+export interface IVerifyChangePhoneNumber {
+    changePhoneId: string;
+    code: string;
+}
 export interface IVerifyResetPhoneNumber {
     resetPhoneNumberToken: string;
     code: string;
@@ -337,10 +482,16 @@ interface WebAuthnLoginResponse {
     signature: string;
     userHandle?: string;
 }
-export interface IWebAuthnPreLogin {
-    email: string;
+export interface IBaseWebAuthnPreLogin {
     recaptchaToken?: string;
 }
+export interface IEmailWebAuthnPreLogin extends IBaseWebAuthnPreLogin {
+    email: string;
+}
+export interface IUserIDWebAuthnPreLogin extends IBaseWebAuthnPreLogin {
+    userId?: string;
+}
+export type IWebAuthnPreLogin = IEmailWebAuthnPreLogin | IUserIDWebAuthnPreLogin;
 interface AllowCredentials {
     type: string;
     id: string;
@@ -359,6 +510,14 @@ export interface IWebAuthnPostLogin {
     invitationToken?: string;
     response: WebAuthnLoginResponse;
 }
+export interface GenerateStepUpRequest {
+    maxAge?: number;
+}
+export interface GenerateStepUpResponse {
+    mfaToken: string;
+    mfaEnrolled: boolean;
+    mfaDevices: UserMFADevicesResponse;
+}
 export interface ICreateNewDeviceSessionResponse {
     rp: {
         name: string;
@@ -386,16 +545,159 @@ interface IWebAuthnRegisterResponse {
 export interface IVerifyNewWebAuthnDevice {
     id: string;
     response: IWebAuthnRegisterResponse;
+    deviceType?: WebAuthnDeviceType;
 }
 export declare enum SecondaryAuthStrategy {
     WebAuthnPlatform = "WebAuthnPlatform",
     WebAuthnCrossPlatform = "WebAuthnCrossPlatform",
-    SmsCode = "SmsCode"
+    SmsCode = "SmsCode",
+    SmsCodeV2 = "SmsCodeV2",
+    Passkeys = "Passkeys"
 }
 export interface IAuthStrategyConfig {
     strategy: SecondaryAuthStrategy;
     isActive: boolean;
 }
+export interface MainAuthStrategy {
+    strategy: AuthStrategyEnum;
+}
 export interface IAuthStrategiesConfig {
     secondaryAuthStrategies: IAuthStrategyConfig[];
+    mainAuthStrategies: MainAuthStrategy[];
+}
+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 {
+    Platform = "Platform",
+    CrossPlatform = "CrossPlatform"
+}
+export interface IWebAuthnDevice {
+    id: string;
+    deviceType: WebAuthnDeviceType;
+    createdAt: Date;
+}
+export interface IWebAuthnDevices {
+    devices: IWebAuthnDevice[];
+}
+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 IPreVerifyCode {
+    otcToken: string;
+}
+export interface IVerifyCode extends IVerifyMFA {
+    otcToken: string;
+    code: string;
+}
+export interface IVerifyMFAAuthenticatorApp extends IVerifyMFA {
+    value: string;
+}
+export interface IPreVerifyMFASMSResponse extends IPreVerifyCode {
+    phoneNumber: string;
+}
+export interface IVerifyMFASMS extends IVerifyCode {
+}
+export interface IPreVerifyMFAEmailCodeResponse {
+    otcToken: string;
+}
+export interface IVerifyMFAEmailCode extends IVerifyCode {
+}
+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",
+    WebAuthnPlatform = "WebAuthnPlatform",
+    WebAuthnCrossPlatform = "WebAuthnCrossPlatform",
+    SMS = "SMS",
+    EmailCode = "EmailCode"
+}
+export interface UserMFAWebAuthnDevice {
+    id: string;
+    deviceType: WebAuthnDeviceType;
+    name: string;
+}
+export interface UserMFAEmail {
+    email: string;
+}
+export interface UserMFAPhoneDevice {
+    id: string;
+    phoneNumber: string;
+}
+export interface UserMFAAuthenticatorApp {
+    id: string;
+}
+export interface UserMFADevicesResponse {
+    webauthn: UserMFAWebAuthnDevice[];
+    phones: UserMFAPhoneDevice[];
+    authenticators: UserMFAAuthenticatorApp[];
+    emails: UserMFAEmail[];
+}
+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'>;
+}
+export interface IPreEnrollMFAAuthenticatorApp {
+    qrCode: string;
+}
+export type WithoutMFAToken<T> = Omit<T | 'mfaToken', 'rememberDevice'>;
+export interface IMFAStrategyResponse {
+    strategy: MFAStrategyEnum;
+    isActive: boolean;
+}
+export interface IMFAStrategiesResponse {
+    strategies: IMFAStrategyResponse[];
 }
+export declare const LOAD_AUTHORIZATION_FF = "admin_portal_should_load_authorization";

package/auth/interfaces.js

@@ -1,15 +1,25 @@
 export * from './secutiry-poilicy/interfaces';
-;
-;
-;
-;
-;
-;
-;
+// SmsCode is for speedy login, SmsCodeV2 is for login with SMS
 export let SecondaryAuthStrategy;
-
 (function (SecondaryAuthStrategy) {
   SecondaryAuthStrategy["WebAuthnPlatform"] = "WebAuthnPlatform";
   SecondaryAuthStrategy["WebAuthnCrossPlatform"] = "WebAuthnCrossPlatform";
   SecondaryAuthStrategy["SmsCode"] = "SmsCode";
-})(SecondaryAuthStrategy || (SecondaryAuthStrategy = {}));
+  SecondaryAuthStrategy["SmsCodeV2"] = "SmsCodeV2";
+  SecondaryAuthStrategy["Passkeys"] = "Passkeys";
+})(SecondaryAuthStrategy || (SecondaryAuthStrategy = {}));
+// WebAuthn
+export let WebAuthnDeviceType;
+(function (WebAuthnDeviceType) {
+  WebAuthnDeviceType["Platform"] = "Platform";
+  WebAuthnDeviceType["CrossPlatform"] = "CrossPlatform";
+})(WebAuthnDeviceType || (WebAuthnDeviceType = {}));
+export let MFAStrategyEnum;
+(function (MFAStrategyEnum) {
+  MFAStrategyEnum["AuthenticatorApp"] = "AuthenticatorApp";
+  MFAStrategyEnum["WebAuthnPlatform"] = "WebAuthnPlatform";
+  MFAStrategyEnum["WebAuthnCrossPlatform"] = "WebAuthnCrossPlatform";
+  MFAStrategyEnum["SMS"] = "SMS";
+  MFAStrategyEnum["EmailCode"] = "EmailCode";
+})(MFAStrategyEnum || (MFAStrategyEnum = {}));
+export const LOAD_AUTHORIZATION_FF = 'admin_portal_should_load_authorization';