Add authentication events

src/common/interfaces/event.interface.ts

@@ -8,6 +8,8 @@ import {
 } from '../../directory-sync/interfaces';
 import { Connection, ConnectionResponse } from '../../sso/interfaces';
 import {
+  AuthenticationEvent,
+  AuthenticationEventResponse,
   Session,
   SessionResponse,
   User,
@@ -28,6 +30,139 @@ interface EventResponseBase {
   created_at: string;
 }
 
+export interface AuthenticationEmailVerificationFailedEvent extends EventBase {
+  event: 'authentication.email_verification_failed';
+  data: AuthenticationEvent;
+}
+
+export interface AuthenticationEmailVerificationFailedEventResponse
+  extends EventResponseBase {
+  event: 'authentication.email_verification_failed';
+  data: AuthenticationEventResponse;
+}
+
+export interface AuthenticationEmailVerificationSucceededEvent
+  extends EventBase {
+  event: 'authentication.email_verification_succeeded';
+  data: AuthenticationEvent;
+}
+
+export interface AuthenticationEmailVerificationSucceededEventResponse
+  extends EventResponseBase {
+  event: 'authentication.email_verification_succeeded';
+  data: AuthenticationEventResponse;
+}
+
+export interface AuthenticationMagicAuthFailedEvent extends EventBase {
+  event: 'authentication.magic_auth_failed';
+  data: AuthenticationEvent;
+}
+
+export interface AuthenticationMagicAuthFailedEventResponse
+  extends EventResponseBase {
+  event: 'authentication.magic_auth_failed';
+  data: AuthenticationEventResponse;
+}
+
+export interface AuthenticationMagicAuthSucceededEvent extends EventBase {
+  event: 'authentication.magic_auth_succeeded';
+  data: AuthenticationEvent;
+}
+
+export interface AuthenticationMagicAuthSucceededEventResponse
+  extends EventResponseBase {
+  event: 'authentication.magic_auth_succeeded';
+  data: AuthenticationEventResponse;
+}
+
+export interface AuthenticationMfaFailedEvent extends EventBase {
+  event: 'authentication.mfa_failed';
+  data: AuthenticationEvent;
+}
+
+export interface AuthenticationMfaFailedEventResponse
+  extends EventResponseBase {
+  event: 'authentication.mfa_failed';
+  data: AuthenticationEventResponse;
+}
+
+export interface AuthenticationMfaSucceededEvent extends EventBase {
+  event: 'authentication.mfa_succeeded';
+  data: AuthenticationEvent;
+}
+
+export interface AuthenticationMfaSucceededEventResponse
+  extends EventResponseBase {
+  event: 'authentication.mfa_succeeded';
+  data: AuthenticationEventResponse;
+}
+
+export interface AuthenticationOAuthFailedEvent extends EventBase {
+  event: 'authentication.oauth_failed';
+  data: AuthenticationEvent;
+}
+
+export interface AuthenticationOAuthFailedEventResponse
+  extends EventResponseBase {
+  event: 'authentication.oauth_failed';
+  data: AuthenticationEventResponse;
+}
+
+export interface AuthenticationOAuthSucceededEvent extends EventBase {
+  event: 'authentication.oauth_succeeded';
+  data: AuthenticationEvent;
+}
+
+export interface AuthenticationOAuthSucceededEventResponse
+  extends EventResponseBase {
+  event: 'authentication.oauth_succeeded';
+  data: AuthenticationEventResponse;
+}
+
+export interface AuthenticationPasswordFailedEvent extends EventBase {
+  event: 'authentication.password_failed';
+  data: AuthenticationEvent;
+}
+
+export interface AuthenticationPasswordFailedEventResponse
+  extends EventResponseBase {
+  event: 'authentication.password_failed';
+  data: AuthenticationEventResponse;
+}
+
+export interface AuthenticationPasswordSucceededEvent extends EventBase {
+  event: 'authentication.password_succeeded';
+  data: AuthenticationEvent;
+}
+
+export interface AuthenticationPasswordSucceededEventResponse
+  extends EventResponseBase {
+  event: 'authentication.password_succeeded';
+  data: AuthenticationEventResponse;
+}
+
+export interface AuthenticationSSOFailedEvent extends EventBase {
+  event: 'authentication.sso_failed';
+  data: AuthenticationEvent;
+}
+
+export interface AuthenticationSSOFailedEventResponse
+  extends EventResponseBase {
+  event: 'authentication.sso_failed';
+  data: AuthenticationEventResponse;
+}
+
+export interface AuthenticationSSOSucceededEvent extends EventBase {
+  event: 'authentication.sso_succeeded';
+  data: AuthenticationEvent;
+}
+
+export interface AuthenticationSSOSucceededEventResponse
+  extends EventResponseBase {
+  event: 'authentication.sso_succeeded';
+  data: AuthenticationEventResponse;
+}
+
 export interface ConnectionActivatedEvent extends EventBase {
   event: 'connection.activated';
   data: Connection;
@@ -257,6 +392,18 @@ export interface SessionCreatedEventResponse extends EventResponseBase {
 }
 
 export type Event =
+  | AuthenticationEmailVerificationFailedEvent
+  | AuthenticationEmailVerificationSucceededEvent
+  | AuthenticationMfaFailedEvent
+  | AuthenticationMfaSucceededEvent
+  | AuthenticationOAuthFailedEvent
+  | AuthenticationOAuthSucceededEvent
+  | AuthenticationSSOFailedEvent
+  | AuthenticationSSOSucceededEvent
+  | AuthenticationPasswordFailedEvent
+  | AuthenticationPasswordSucceededEvent
+  | AuthenticationMagicAuthFailedEvent
+  | AuthenticationMagicAuthSucceededEvent
   | ConnectionActivatedEvent
   | ConnectionDeactivatedEvent
   | ConnectionDeletedEvent
@@ -280,6 +427,18 @@ export type Event =
   | SessionCreatedEvent;
 
 export type EventResponse =
+  | AuthenticationEmailVerificationFailedEventResponse
+  | AuthenticationEmailVerificationSucceededEventResponse
+  | AuthenticationMagicAuthFailedEventResponse
+  | AuthenticationMagicAuthSucceededEventResponse
+  | AuthenticationMfaFailedEventResponse
+  | AuthenticationMfaSucceededEventResponse
+  | AuthenticationOAuthFailedEventResponse
+  | AuthenticationOAuthSucceededEventResponse
+  | AuthenticationPasswordFailedEventResponse
+  | AuthenticationPasswordSucceededEventResponse
+  | AuthenticationSSOFailedEventResponse
+  | AuthenticationSSOSucceededEventResponse
   | ConnectionActivatedEventResponse
   | ConnectionDeactivatedEventResponse
   | ConnectionDeletedEventResponse

src/common/serializers/event.serializer.ts

@@ -8,6 +8,7 @@ import {
 } from '../../directory-sync/serializers';
 import { deserializeConnection } from '../../sso/serializers';
 import { deserializeUser } from '../../user-management/serializers';
+import { deserializeAuthenticationEvent } from '../../user-management/serializers/authentication-event.serializer';
 import { deserializeOrganizationMembership } from '../../user-management/serializers/organization-membership.serializer';
 import { deserializeSession } from '../../user-management/serializers/session.serializer';
 import { Event, EventBase, EventResponse } from '../interfaces';
@@ -19,6 +20,23 @@ export const deserializeEvent = (event: EventResponse): Event => {
   };
 
   switch (event.event) {
+    case 'authentication.email_verification_failed':
+    case 'authentication.email_verification_succeeded':
+    case 'authentication.magic_auth_failed':
+    case 'authentication.magic_auth_succeeded':
+    case 'authentication.mfa_failed':
+    case 'authentication.mfa_succeeded':
+    case 'authentication.oauth_failed':
+    case 'authentication.oauth_succeeded':
+    case 'authentication.password_failed':
+    case 'authentication.password_succeeded':
+    case 'authentication.sso_failed':
+    case 'authentication.sso_succeeded':
+      return {
+        ...eventBase,
+        event: event.event,
+        data: deserializeAuthenticationEvent(event.data),
+      };
     case 'connection.activated':
     case 'connection.deactivated':
     case 'connection.deleted':

src/user-management/interfaces/authentication-event.interface.ts

@@ -0,0 +1,30 @@
+interface AuthenticationEventError {
+  code: string;
+  message: string;
+}
+
+export type AuthenticationEventType =
+  | 'sso'
+  | 'password'
+  | 'oauth'
+  | 'mfa'
+  | 'magic_auth'
+  | 'email_verification';
+
+export type AuthenticationEvent = {
+  type: AuthenticationEventType;
+  email?: string | null;
+  ipAddress: string | null;
+  userAgent: string | null;
+  userId: string | null;
+  error?: AuthenticationEventError;
+};
+
+export interface AuthenticationEventResponse {
+  type: AuthenticationEventType;
+  email?: string | null;
+  ip_address: string | null;
+  user_agent: string | null;
+  user_id: string | null;
+  error?: AuthenticationEventError;
+}

src/user-management/interfaces/index.ts

@@ -1,3 +1,4 @@
+export * from './authentication-event.interface';
 export * from './authenticate-with-magic-auth-options.interface';
 export * from './authenticate-with-password-options.interface';
 export * from './authenticate-with-code-options.interface';

src/user-management/serializers/authentication-event.serializer.ts

@@ -0,0 +1,15 @@
+import {
+  AuthenticationEvent,
+  AuthenticationEventResponse,
+} from '../interfaces';
+
+export const deserializeAuthenticationEvent = (
+  authenticationEvent: AuthenticationEventResponse,
+): AuthenticationEvent => ({
+  type: authenticationEvent.type,
+  email: authenticationEvent.email,
+  ipAddress: authenticationEvent.ip_address,
+  userAgent: authenticationEvent.user_agent,
+  userId: authenticationEvent.user_id,
+  error: authenticationEvent.error,
+});