@frontegg/rest-api 2.10.90 → 3.0.1

package/src/auth/interfaces.ts

@@ -1,488 +0,0 @@
-import { ITenantsResponse, IUserProfile } from '..';
-import { AuthStrategyEnum, SocialLoginProviders } from "./enums";
-import { ISamlRolesGroup } from '../teams/interfaces';
-
-export * from './secutiry-poilicy/interfaces';
-
-export type IPreLogin = { email: string };
-export type IPostLogin = {
-  RelayState: string;
-  SAMLResponse: string;
-};
-
-export type IPreLoginWithIdpTypeResponse = {
-  address: string;
-  idpType: 'saml' | 'oidc';
-}
-
-export type IOidcPostLogin = {
-  code: string;
-  state: string;
-  redirectUri?: string;
-};
-
-export type IOidcPostLoginV2 = {
-  code: string;
-  RelayState: string;
-  redirectUri?: string;
-};
-
-export type ILogin = { email: string; password: string; recaptchaToken?: string; invitationToken?: string; };
-
-export type ILoginResponse = IUserProfile & {
-  mfaRequired: boolean;
-  accessToken: string;
-  refreshToken: string;
-  expires: string;
-  expiresIn: number;
-  mfaToken?: string; // for multi-factor authentication
-  qrCode?: string;
-  recoveryCode?: string;
-  emailVerified?: boolean;
-  redirectLocation?: string;
-  userEmail?: string;
-};
-
-export type ILoginResponseV2 = {
-  user: ILoginResponse,
-  tenants?: ITenantsResponse[]
-}
-
-export type ILoginWithMfa = {
-  mfaToken: string;
-  value: string;
-  rememberDevice?: boolean;
-  invitationToken?: string;
-};
-
-export type IActivateAccount = {
-  userId: string;
-  token: string;
-  password?: string;
-  recaptchaToken?: string;
-};
-
-export type IAcceptInvitation = {
-  userId: string;
-  token: string;
-};
-
-export type IResendActivationEmail = { email: string };
-
-export type IForgotPassword = { email: string };
-
-export type IResetPassword = {
-  token: string;
-  userId: string;
-  password: string;
-};
-
-export type IRecoverMFAToken = {
-  email: string;
-  recoveryCode: string;
-};
-
-export type IEnrollMfaResponse = {
-  qrCode: string; // QR Code image as base64
-};
-
-export type IVerifyMfa = {
-  token: string;
-};
-
-export type IVerifyMfaResponse = {
-  recoveryCode: string;
-};
-
-export type IDisableMfa = {
-  token: string;
-};
-
-export type ISamlConfiguration = {
-  enabled: boolean;
-  domain?: string;
-  validated?: boolean;
-  generatedVerification?: string;
-  ssoEndpoint?: string;
-  publicCertificate?: string;
-  signRequest?: boolean;
-  createdAt?: Date;
-  updatedAt?: Date;
-  acsUrl?: string;
-  spEntityId?: string;
-  isSamlActive?: boolean;
-  oidcClientId?: string;
-  oidcSecret?: string;
-  type?: string;
-};
-
-export type IOidcConfiguration = {
-  active: boolean;
-  redirectUri?: string;
-};
-
-export type ISSOPublicConfiguration = {
-  isActive: boolean;
-}
-
-export type IUpdateSamlConfiguration = Omit<ISamlConfiguration, 'validated' | 'generatedVerification' | 'createdAt' | 'updatedAt'>;
-export type ISamlVendorConfigResponse = {
-  acsUrl: string;
-  spEntityId: string;
-};
-
-export type ISamlVendorMetadata = {
-  id: string;
-  vendorId: string;
-  entityName: 'saml';
-  configuration: ISamlVendorConfigResponse;
-};
-
-export type IUpdateSamlVendorMetadata = {
-  metadata: string;
-};
-
-export interface ISocialLoginProviderConfiguration {
-  type: SocialLoginProviders;
-  clientId: string;
-  redirectUrl: string;
-  active: boolean;
-}
-
-export interface ISocialLoginProviderConfigurationV2 {
-  type: SocialLoginProviders;
-  clientId?: string | null;
-  redirectUrl: string;
-  active: boolean;
-  authorizationUrl?: string | null;
-  customised: boolean;
-}
-
-export interface ILoginViaSocialLogin {
-  code: string;
-  redirectUri?: string;
-  provider: SocialLoginProviders;
-  afterAuthRedirectUrl?: string;
-  codeVerifier?: string;
-  metadata?: string;
-  invitationToken?: string;
-  state?: string
-}
-
-export interface ILoginViaSocialLoginResponse {
-  email: string;
-  isNewUser: boolean;
-  userId?: string;
-  tenantId?: string;
-  name: string;
-  accessToken: string;
-  mfaRequired: boolean;
-  userEmail?: string;
-}
-
-export interface ISetSocialLoginError {
-  error: string;
-}
-
-export interface IVendorConfig {
-  allowSignups: boolean;
-  allowNotVerifiedUsersLogin: boolean;
-  apiTokensEnabled: boolean;
-  forcePermissions: boolean;
-  authStrategy: AuthStrategyEnum;
-}
-
-export interface ISignUpUser {
-  email: string;
-  companyName: string;
-  recaptchaToken?: string;
-  name?: string;
-  password?: string;
-  phoneNumber?: string;
-  metadata?: string /** JSON  */
-  ;
-  roleIds?: string[];
-  invitationToken?: string;
-}
-
-export interface ISignUpResponse {
-  shouldActivate: boolean;
-  user?: ILoginResponse;
-  userId?: string;
-  tenantId?: string;
-}
-
-export interface ISessionResponse {
-  id: string;
-	expires?: Date;
-	ipAddress?: string;
-	userAgent?: string;
-	createdAt?: Date;
-	current?: 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;
-}
-
-export interface ITenantApiTokensData {
-  clientId?: string;
-  description: string;
-  tenantId?: string;
-  createdByUserId?: string;
-  metadata?: any;
-  secret?: string;
-  roleIds?: string[];
-}
-
-export interface IUpdateUserApiTokensData {
-  description: string;
-}
-
-export interface IUpdateTenantApiTokensData {
-  description: string;
-  roleIds: string[];
-}
-
-export interface IDeleteApiToken {
-  tokenId: string;
-}
-
-export interface IUpdateSamlRoles {
-  roleIds: string[];
-}
-
-export interface IUpdateSamlGroup {
-  id: string;
-  group: string;
-  roleIds: string[];
-}
-
-export interface ICreateSamlGroup {
-  group: string;
-  roleIds?: string[];
-}
-
-export type IGetUserById = { userId: string };
-
-export interface IUserIdResponse {
-  id: string;
-  name: string;
-  deletedAt: null;
-  metadata: any;
-  tenantId: string;
-  vendorId: string;
-  createdAt: Date;
-  updatedAt: Date;
-}
-
-export interface IGetUserPasswordConfig {
-  userId: string;
-}
-
-export interface IGetActivateAccountStrategy {
-  userId: string;
-  token: string;
-}
-
-export interface IGetActivateAccountStrategyResponse {
-  shouldSetPassword: boolean;
-}
-
-export interface IAllowedToRememberMfaDevice {
-  isAllowedToRemember: boolean;
-  mfaDeviceExpiration: number;
-}
-
-export interface IPasswordlessPreLogin {
-  email: string;
-  recaptchaToken?: string;
-  type: AuthStrategyEnum;
-  invitationToken?: string;
-}
-
-export interface IPasswordlessPostLogin {
-  token: string;
-  recaptchaToken?: string;
-  type: AuthStrategyEnum;
-  invitationToken?: string;
-}
-
-export interface IVerifyInviteToken {
-  token: string;
-}
-
-export interface ICreateSSODomain {
-  domain: string;
-}
-
-export interface ISSODomain {
-  id: string
-  domain: string;
-  validated: boolean;
-}
-
-export interface ISSOConfigurationDefaultRoles {
-  roleIds: string[]
-}
-
-export interface ISSOConfiguration {
-  id: string;
-  enabled: boolean;
-  generatedVerification: string;
-  ssoEndpoint: string;
-  publicCertificate: string;
-  signRequest: boolean;
-  createdAt?: string;
-  updatedAt?: string;
-  acsUrl: string;
-  type: string;
-  spEntityId: string;
-  oidcClientId: string;
-  oidcSecret: string;
-  domains: ISSODomain[];
-  roleIds: string[];
-  groups: ISamlRolesGroup[]
-}
-
-export interface IExchangeOAuthTokens {
-  code: string;
-  redirect_uri: string;
-  code_verifier: string;
-}
-
-export interface IOAuthTokenResponse {
-  access_token: string;
-  expires_in?: number;
-  id_token: string;
-  refresh_token: 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
-};
-
-export interface IVerifyResetPhoneNumberResponse {
-  changePhoneNumberToken: string;
-};
-
-export interface IChangePhoneNumber {
-  changePhoneNumberToken: string;
-  phoneNumber: string;
-};
-
-interface WebAuthnLoginResponse {
-  clientDataJSON: string;
-  authenticatorData: string;
-  signature: string;
-  userHandle?: string;
-}
-
-export interface IWebAuthnPreLogin {
-  email: string;
-  recaptchaToken?: string;
-};
-
-interface AllowCredentials {
-  type: string;
-  id: string;
-  transports?: string[];
-}
-
-export interface IWebAuthnPreLoginResponse {
-  challenge: string;
-  allowCredentials?: AllowCredentials[];
-  timeout?: number;
-  rpId?: string;
-  userVerification?: UserVerificationRequirement;
-}
-
-export interface IWebAuthnPostLogin {
-  id: string;
-  recaptchaToken?: string;
-  invitationToken?: string;
-  response: WebAuthnLoginResponse
-};
-
-export interface ICreateNewDeviceSessionResponse {
-  rp: { name: string; id: string; icon?: string };
-  user: { id: string; name: string; displayName: string; };
-  challenge: string;
-  pubKeyCredParams: Array<{ type: 'public-key'; alg: number }>;
-  excludeCredentials?: AllowCredentials[];
-  timeout?: number;
-  authenticatorSelection?: AuthenticatorSelectionCriteria;
-}
-
-interface IWebAuthnRegisterResponse {
-  clientDataJSON: string;
-  attestationObject: string;
-}
-
-export interface IVerifyNewWebAuthnDevice {
-  id: string;
-  response: IWebAuthnRegisterResponse
-}
-
-export enum SecondaryAuthStrategy {
-  WebAuthnPlatform = 'WebAuthnPlatform',
-  WebAuthnCrossPlatform = 'WebAuthnCrossPlatform',
-  SmsCode = 'SmsCode'
-}
-
-export interface IAuthStrategyConfig {
-  strategy: SecondaryAuthStrategy;
-  isActive: boolean;
-}
-
-export interface IAuthStrategiesConfig {
-  secondaryAuthStrategies: IAuthStrategyConfig[]
-}

package/src/auth/secutiry-poilicy/index.ts

@@ -1,109 +0,0 @@
-import {
-  ISaveSecurityPolicyMfa,
-  ISaveSecurityPolicyLockout,
-  ISecurityPolicyMfa,
-  ISecurityPolicyLockout,
-  ISecurityPolicyCaptcha,
-  ISecurityPolicyPasswordHistory,
-  ISaveSecurityPolicyPasswordHistory,
-  ISecurityPolicyPasswordConfig, ISecurityPolicy,
-} from './interfaces';
-import {Get, Patch, Post} from '../../fetch';
-import {urls} from '../../constants';
-
-/**
- * Get global secure access configuration
- */
-export async function getGlobalSecurityPolicy(): Promise<ISecurityPolicy> {
-  console.debug('getGlobalSecurityPolicy()');
-  return Get(urls.identity.configurations.v1);
-}
-
-/**
- * Get Mfa configuration from security policy
- */
-export async function getMfaPolicy(): Promise<ISecurityPolicyMfa> {
-  console.debug('getMfaPolicy()');
-  return Get(`${urls.identity.configurations.v1}/mfa-policy`);
-}
-
-/**
- * Get Mfa configuration from security policy
- */
- export async function getVendorMfaPolicy(): Promise<ISecurityPolicyMfa> {
-  console.debug('getVendorMfaPolicy()');
-  return Get(`${urls.identity.configurations.v1}/mfa-policy/vendor`);
-}
-
-/**
- * Create/Update Mfa configuration from security policy
- */
-export async function saveMfaPolicy(body: ISaveSecurityPolicyMfa): Promise<ISecurityPolicyMfa> {
-  console.debug('saveMfaPolicy()');
-  if (body.id) {
-    return Patch(`${urls.identity.configurations.v1}/mfa-policy`, body);
-  } else {
-    return Post(`${urls.identity.configurations.v1}/mfa-policy`, body);
-  }
-}
-
-/**
- * Get Lockout configuration from security policy
- */
-export async function getLockoutPolicy(): Promise<ISecurityPolicyLockout> {
-  console.debug('getLockoutPolicy()');
-  return Get(`${urls.identity.configurations.v1}/lockout-policy`);
-}
-
-/**
- * Create/Update Lockout configuration from security policy
- */
-export async function saveLockoutPolicy(body: ISaveSecurityPolicyLockout): Promise<ISecurityPolicyLockout> {
-  console.debug('saveLockoutPolicy()');
-  if (body.id) {
-    return Patch(`${urls.identity.configurations.v1}/lockout-policy`, body);
-  } else {
-    return Post(`${urls.identity.configurations.v1}/lockout-policy`, body);
-  }
-}
-
-/**
- * Get Captcha configuration from security policy
- */
-export async function getCaptchaPolicy(): Promise<ISecurityPolicyCaptcha | null> {
-  try {
-    return await Get(`${urls.identity.configurations.v1}/captcha-policy/public`);
-  } catch {
-    return null;
-  }
-}
-
-/**
- * Get Password History configuration from security policy
- */
-export async function getPasswordHistoryPolicy(): Promise<ISecurityPolicyPasswordHistory> {
-  console.debug('getPasswordHistoryPolicy()');
-  return Get(`${urls.identity.configurations.v1}/password-history-policy`);
-}
-
-/**
- * Create/Update Password History configuration from security policy
- */
-export async function savePasswordHistoryPolicy(
-  body: ISaveSecurityPolicyPasswordHistory
-): Promise<ISecurityPolicyPasswordHistory> {
-  console.debug('savePasswordHistoryPolicy()');
-  if (body.id) {
-    return Patch(`${urls.identity.configurations.v1}/password-history-policy`, body);
-  } else {
-    return Post(`${urls.identity.configurations.v1}/password-history-policy`, body);
-  }
-}
-
-/**
- * load vendor password configuration.
- */
-export async function getPasswordConfigPolicy(): Promise<ISecurityPolicyPasswordConfig> {
-  console.debug('getPasswordConfigPolicy()');
-  return Get(`${urls.identity.configurations.v1}/password`);
-}

package/src/auth/secutiry-poilicy/interfaces.ts

@@ -1,81 +0,0 @@
-export type EnforceMFAType = 'DontForce' | 'Force' | 'ForceExceptSAML';
-
-export interface ISecurityPolicy {
-  id: string;
-  enforceMFAType?: EnforceMFAType;
-  createdAt: Date;
-  updatedAt: Date;
-  allowOverrideEnforcePasswordHistory: boolean;
-  allowOverridePasswordComplexity: boolean;
-  allowOverridePasswordExpiration: boolean;
-  allowSignups: boolean;
-  apiTokensEnabled: boolean;
-  cookieSameSite: string;
-  defaultRefreshTokenExpiration: number;
-  defaultTokenExpiration: number;
-  publicKey: string;
-}
-
-export interface ISecurityPolicyMfa {
-  id: string;
-  enforceMFAType: EnforceMFAType;
-  createdAt: Date;
-  updatedAt: Date;
-}
-
-export interface ISaveSecurityPolicyMfa {
-  id?: string;
-  enforceMFAType: EnforceMFAType;
-}
-
-export interface ISecurityPolicyLockout {
-  id: string;
-  enabled: boolean;
-  maxAttempts: number;
-  createdAt: Date;
-  updatedAt: Date;
-}
-
-export interface ISaveSecurityPolicyLockout {
-  id?: string;
-  enabled: boolean;
-  maxAttempts: number;
-}
-
-export interface ISecurityPolicyCaptcha {
-  id: string;
-  siteKey: string;
-  enabled: boolean;
-  createdAt: Date;
-  updatedAt: Date;
-}
-
-export interface ISaveSecurityPolicyCaptcha {
-  id?: string;
-  siteKey: string;
-  enabled: boolean;
-}
-
-export interface ISecurityPolicyPasswordHistory {
-  id: string;
-  enabled: boolean;
-  historySize: number;
-  createdAt: Date;
-  updatedAt: Date;
-}
-
-export interface ISaveSecurityPolicyPasswordHistory {
-  id?: string;
-  enabled: boolean;
-  historySize: number;
-}
-
-export interface TestConfig {
-  allowPassphrases: boolean;
-  maxLength: number;
-  minLength: number;
-  minPhraseLength: number;
-  minOptionalTestsToPass: number;
-}
-
-export type ISecurityPolicyPasswordConfig = Partial<TestConfig>;