feat: expose authentication method on action contexts

src/actions/actions.spec.ts

@@ -131,6 +131,7 @@ describe('Actions', () => {
           externalId: null,
           metadata: {},
         },
+        authenticationMethod: 'Password',
         ipAddress: '50.141.123.10',
         userAgent: 'Mozilla/5.0',
         deviceFingerprint: 'notafingerprint',
@@ -183,6 +184,7 @@ describe('Actions', () => {
           firstName: 'Jane',
           lastName: 'Doe',
         },
+        authenticationMethod: 'GoogleOAuth',
         ipAddress: '50.141.123.10',
         userAgent: 'Mozilla/5.0',
         deviceFingerprint: 'notafingerprint',
@@ -197,5 +199,19 @@ describe('Actions', () => {
         }),
       });
     });
+
+    it('leaves the authentication method undefined when the payload omits it', async () => {
+      const { authentication_method: _omitted, ...payload } =
+        mockAuthActionContext;
+      const sigHeader = makeSigHeader(payload, secret);
+      const action = await workos.actions.constructAction({
+        payload,
+        sigHeader,
+        secret,
+      });
+
+      expect(action.authenticationMethod).toBeUndefined();
+      expect(action.object).toEqual('authentication_action_context');
+    });
   });
 });

src/actions/fixtures/authentication-action-context.json

@@ -12,6 +12,7 @@
         "created_at": "2024-10-22T17:12:50.746Z",
         "updated_at": "2024-10-22T17:12:50.746Z"
     },
+    "authentication_method": "Password",
     "ip_address": "50.141.123.10",
     "user_agent": "Mozilla/5.0",
     "device_fingerprint": "notafingerprint",

src/actions/fixtures/user-registration-action-context.json

@@ -7,6 +7,7 @@
         "first_name": "Jane",
         "last_name": "Doe"
     },
+    "authentication_method": "GoogleOAuth",
     "ip_address": "50.141.123.10",
     "user_agent": "Mozilla/5.0",
     "device_fingerprint": "notafingerprint",

src/actions/interfaces/action.interface.ts

@@ -3,6 +3,7 @@ import {
   OrganizationResponse,
 } from '../../organizations/interfaces';
 import {
+  AuthenticationMethod,
   Invitation,
   InvitationResponse,
   OrganizationMembership,
@@ -17,6 +18,7 @@ interface AuthenticationActionContext {
   user: User;
   organization?: Organization;
   organizationMembership?: OrganizationMembership;
+  authenticationMethod?: AuthenticationMethod;
   ipAddress?: string;
   userAgent?: string;
   deviceFingerprint?: string;
@@ -36,6 +38,7 @@ interface UserRegistrationActionContext {
   object: 'user_registration_action_context';
   userData: UserData;
   invitation?: Invitation;
+  authenticationMethod?: AuthenticationMethod;
   ipAddress?: string;
   userAgent?: string;
   deviceFingerprint?: string;
@@ -50,6 +53,7 @@ interface AuthenticationActionPayload {
   user: UserResponse;
   organization?: OrganizationResponse;
   organization_membership?: OrganizationMembershipResponse;
+  authentication_method?: AuthenticationMethod;
   ip_address?: string;
   user_agent?: string;
   device_fingerprint?: string;
@@ -69,6 +73,7 @@ export interface UserRegistrationActionPayload {
   object: 'user_registration_action_context';
   user_data: UserDataPayload;
   invitation?: InvitationResponse;
+  authentication_method?: AuthenticationMethod;
   ip_address?: string;
   user_agent?: string;
   device_fingerprint?: string;

src/actions/serializers/action.serializer.ts

@@ -33,7 +33,7 @@ export const deserializeAction = (
         invitation: actionPayload.invitation
           ? deserializeInvitation(actionPayload.invitation)
           : undefined,
-
+        authenticationMethod: actionPayload.authentication_method,
         ipAddress: actionPayload.ip_address,
         userAgent: actionPayload.user_agent,
         deviceFingerprint: actionPayload.device_fingerprint,
@@ -51,6 +51,7 @@ export const deserializeAction = (
               actionPayload.organization_membership,
             )
           : undefined,
+        authenticationMethod: actionPayload.authentication_method,
         ipAddress: actionPayload.ip_address,
         userAgent: actionPayload.user_agent,
         deviceFingerprint: actionPayload.device_fingerprint,

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

@@ -2,7 +2,7 @@ import { Impersonator, ImpersonatorResponse } from './impersonator.interface';
 import { OauthTokens, OauthTokensResponse } from './oauth-tokens.interface';
 import { User, UserResponse } from './user.interface';
 
-type AuthenticationMethod =
+export type AuthenticationMethod =
   | 'SSO'
   | 'Password'
   | 'Passkey'
@@ -12,6 +12,8 @@ type AuthenticationMethod =
   | 'GitHubOAuth'
   | 'GitLabOAuth'
   | 'GoogleOAuth'
+  | 'GrokOAuth'
+  | 'XOAuth'
   | 'IntuitOAuth'
   | 'LinkedInOAuth'
   | 'MicrosoftOAuth'