feat(workflows): preserve execution principals (#6891)

* feat(workflows): preserve execution principals

* fix(credential-groups): list all managed credentials

* fix(credential-groups): restore email credential filtering

* fix(workflows): resume legacy execution snapshots

* test(workflows): align execution principal fixtures

* fix(workflows): keep snapshot metadata first

* fix(credential-groups): resolve external actor enrollments

* fix(workflows): resume legacy queued jobs

* fix(workflows): preserve execution principal authority

* chore(core): format principal operation types

* fix(workflows): restore legacy paused api key actors

* chore(design): remove principal design documents

Author: TheodoreSpeaks

apps/sim/app/api/auth/oauth/token/route.ts

@@ -1,5 +1,8 @@
 import { AuditAction, AuditResourceType, recordAudit } from '@sim/audit'
-import type { WorkflowExecutionDelegatedPrincipal } from '@sim/auth/principal'
+import {
+  resolvePrincipalSubject,
+  type WorkflowExecutionDelegatedPrincipal,
+} from '@sim/auth/principal'
 import { createLogger } from '@sim/logger'
 import { getErrorMessage } from '@sim/utils/errors'
 import { type NextRequest, NextResponse } from 'next/server'
@@ -206,16 +209,19 @@ export const POST = withRouteHandler(async (request: NextRequest) => {
           request,
         })
 
-        captureServerEvent(
-          managedOAuthPrincipal.subjectUserId,
-          'credential_used',
-          {
-            credential_type: 'managed_oauth',
-            provider_id: toolMetadata.oauth.provider,
-            workspace_id: managedOAuthPrincipal.workspaceId,
-          },
-          { groups: { workspace: managedOAuthPrincipal.workspaceId } }
-        )
+        const managedOAuthSubject = resolvePrincipalSubject(managedOAuthPrincipal)
+        if (managedOAuthSubject?.kind === 'sim_user') {
+          captureServerEvent(
+            managedOAuthSubject.userId,
+            'credential_used',
+            {
+              credential_type: 'managed_oauth',
+              provider_id: toolMetadata.oauth.provider,
+              workspace_id: managedOAuthPrincipal.workspaceId,
+            },
+            { groups: { workspace: managedOAuthPrincipal.workspaceId } }
+          )
+        }
 
         return NextResponse.json(
           {

apps/sim/app/api/chat/[identifier]/route.ts

@@ -310,6 +310,12 @@ export const POST = withRouteHandler(
               resolvedActorUserId,
               {
                 enabled: true,
+                principal: {
+                  kind: 'system',
+                  serviceId: 'chat',
+                  workspaceId,
+                  workflowId: deployment.workflowId,
+                },
                 selectedOutputs,
                 isSecureMode: true,
                 workflowTriggerType: 'chat',

apps/sim/app/api/files/uploads/purposes.ts

@@ -251,6 +251,8 @@ async function principalUserId(principal: Principal, workspaceId?: string): Prom
       }
     case 'delegated':
       throw new UploadSessionError('forbidden', 'Delegated principals cannot create uploads')
+    case 'system':
+      throw new UploadSessionError('forbidden', 'System principals cannot create uploads')
     case 'credential_group_enrollment':
       throw new UploadSessionError(
         'forbidden',

apps/sim/app/api/mcp/serve/[serverId]/route.test.ts

@@ -70,6 +70,24 @@ function createResolvedSecretTraceProvenance(userId: string, workspaceId = 'ws-1
   }
 }
 
+const SESSION_PRINCIPAL = {
+  kind: 'session',
+  userId: 'user-1',
+  sessionId: 'session-1',
+} as const
+
+const PERSONAL_API_KEY_PRINCIPAL = {
+  kind: 'personal_api_key',
+  userId: 'user-1',
+  keyId: 'personal-key-1',
+} as const
+
+const WORKSPACE_API_KEY_PRINCIPAL = {
+  kind: 'workspace_api_key',
+  workspaceId: 'ws-1',
+  keyId: 'workspace-key-1',
+} as const
+
 vi.mock('@/lib/workspaces/permissions/utils', () => permissionsMock)
 
 vi.mock('@/lib/auth/internal', () => ({
@@ -215,6 +233,7 @@ describe('MCP Serve Route', () => {
       success: true,
       userId: 'user-1',
       authType: 'session',
+      principal: SESSION_PRINCIPAL,
     })
     mockGetUserEntityPermissions.mockResolvedValueOnce('read')
 
@@ -273,6 +292,7 @@ describe('MCP Serve Route', () => {
       userId: 'user-1',
       authType: 'api_key',
       apiKeyType: 'personal',
+      principal: PERSONAL_API_KEY_PRINCIPAL,
     })
     mockGetUserEntityPermissions.mockResolvedValueOnce('write')
     mockExecuteWorkflowService.mockResolvedValueOnce({
@@ -334,6 +354,7 @@ describe('MCP Serve Route', () => {
       userId: 'user-1',
       authType: 'api_key',
       apiKeyType: 'personal',
+      principal: PERSONAL_API_KEY_PRINCIPAL,
     })
     mockGetUserEntityPermissions.mockResolvedValueOnce('write')
 
@@ -375,6 +396,7 @@ describe('MCP Serve Route', () => {
       authType: 'api_key',
       apiKeyType: 'workspace',
       workspaceId: 'ws-1',
+      principal: WORKSPACE_API_KEY_PRINCIPAL,
     })
     mockGetUserEntityPermissions.mockResolvedValueOnce('write')
     mockExecuteWorkflowService.mockResolvedValueOnce({
@@ -477,6 +499,7 @@ describe('MCP Serve Route', () => {
       success: true,
       userId: 'user-1',
       authType: 'session',
+      principal: SESSION_PRINCIPAL,
     })
     mockGetUserEntityPermissions.mockResolvedValueOnce('read')
     mockExecuteWorkflowService.mockResolvedValueOnce({
@@ -1096,6 +1119,7 @@ describe('MCP Serve Route', () => {
       userId: 'user-1',
       authType: 'api_key',
       apiKeyType: 'personal',
+      principal: PERSONAL_API_KEY_PRINCIPAL,
     })
     mockGetUserEntityPermissions.mockResolvedValueOnce('write')
     mockExecuteWorkflowService.mockResolvedValueOnce({
@@ -1193,6 +1217,7 @@ describe('MCP Serve Route', () => {
       authType: 'api_key',
       apiKeyType: 'workspace',
       workspaceId: 'ws-1',
+      principal: WORKSPACE_API_KEY_PRINCIPAL,
     })
     mockGetUserEntityPermissions.mockResolvedValueOnce('write')
     mockExecuteWorkflowService.mockResolvedValueOnce({

apps/sim/app/api/mcp/serve/[serverId]/route.ts

@@ -17,6 +17,7 @@ import {
   SUPPORTED_PROTOCOL_VERSIONS,
   type Tool,
 } from '@modelcontextprotocol/sdk/types.js'
+import type { WorkflowExecutionPrincipal } from '@sim/auth/principal'
 import { db } from '@sim/db'
 import {
   workflow,
@@ -96,6 +97,7 @@ interface RouteParams {
 interface ExecuteAuthContext {
   userId: string
   useAuthenticatedUserAsActor: boolean
+  principal: WorkflowExecutionPrincipal
 }
 
 function createResponse(id: RequestId, result: unknown): JSONRPCResultResponse {
@@ -364,6 +366,9 @@ async function authorizeMcpServeRequest(
   if (!auth.success || !auth.userId) {
     return { response: NextResponse.json({ error: 'Unauthorized' }, { status: 401 }) }
   }
+  if (!auth.principal) {
+    throw new Error('Authenticated MCP request is missing its principal')
+  }
 
   if (server.isPublic) return {}
 
@@ -396,6 +401,7 @@ async function authorizeMcpServeRequest(
     executeAuthContext: {
       userId: auth.userId,
       useAuthenticatedUserAsActor: isPersonalApiKey,
+      principal: auth.principal,
     },
   }
 }
@@ -856,6 +862,14 @@ async function handleToolsCall(
      */
     const serviceResult = await executeWorkflowService({
       workflowId: tool.workflowId,
+      principal:
+        executeAuthContext?.principal ??
+        ({
+          kind: 'system',
+          serviceId: 'public_api',
+          workspaceId: wf.workspaceId,
+          workflowId: tool.workflowId,
+        } satisfies WorkflowExecutionPrincipal),
       userId: actorUserId,
       input: workflowInput,
       triggerType: 'mcp',

apps/sim/app/api/resume/[workflowId]/[executionId]/[contextId]/route.test.ts

@@ -113,12 +113,21 @@ function createPausedExecution(overrides: PausedExecutionOverrides = {}) {
     executionId: overrides.executionId ?? EXECUTION_ID,
     executionSnapshot: {
       snapshot: JSON.stringify({
+        version: 1,
         metadata: {
           requestId: 'request-original',
           workflowId: overrides.snapshotWorkflowId ?? WORKFLOW_ID,
           executionId: overrides.snapshotExecutionId ?? EXECUTION_ID,
           workspaceId: overrides.snapshotWorkspaceId ?? WORKSPACE_ID,
           userId: overrides.snapshotActorUserId ?? PERSISTED_ACTOR_ID,
+          principal: {
+            version: 1,
+            principal: {
+              kind: 'session',
+              userId: overrides.snapshotActorUserId ?? PERSISTED_ACTOR_ID,
+              sessionId: 'session-original',
+            },
+          },
           billingAttribution,
           triggerType: 'manual',
           useDraftState: false,

apps/sim/app/api/tools/windchill/route.ts

@@ -1,4 +1,7 @@
-import type { WorkflowExecutionDelegatedPrincipal } from '@sim/auth/principal'
+import {
+  type BoundWorkflowExecutionDelegatedPrincipal,
+  requirePrincipalSubjectUserId,
+} from '@sim/auth/principal'
 import { createLogger } from '@sim/logger'
 import { getErrorMessage } from '@sim/utils/errors'
 import { type NextRequest, NextResponse } from 'next/server'
@@ -53,16 +56,16 @@ const windchillSessionOrExecutorAuth = createInternalSessionOrExecutorAuth({
 
 async function authenticateWindchillExecutor(
   request: NextRequest
-): Promise<WorkflowExecutionDelegatedPrincipal> {
+): Promise<BoundWorkflowExecutionDelegatedPrincipal> {
   const principal = await windchillSessionOrExecutorAuth.authenticate(request, {})
   if (
     principal.kind !== 'delegated' ||
     principal.serviceId !== 'executor' ||
-    !('delegationContext' in principal)
+    !principal.delegationContext
   ) {
     throw new InternalUnauthenticatedError('Authentication required')
   }
-  return principal
+  return { ...principal, delegationContext: principal.delegationContext }
 }
 
 type WindchillRouteOutput = Extract<WindchillOperationResponse, { success: true }>['output']
@@ -485,7 +488,7 @@ async function storeDownloadedFile({
   fileName,
   contentType,
 }: {
-  principal: WorkflowExecutionDelegatedPrincipal
+  principal: BoundWorkflowExecutionDelegatedPrincipal
   buffer: Buffer
   fileName: string
   contentType: string
@@ -501,14 +504,14 @@ async function storeDownloadedFile({
       buffer,
       fileName,
       contentType,
-      principal.subjectUserId
+      requirePrincipalSubjectUserId(principal)
     )
   }
   return uploadCopilotFile({
     buffer,
     fileName,
     contentType,
-    userId: principal.subjectUserId,
+    userId: requirePrincipalSubjectUserId(principal),
   })
 }
 
@@ -518,7 +521,7 @@ async function executeDownload(
     | { operation: 'windchill_download_primary_content' }
     | { operation: 'windchill_download_attachment' }
   >,
-  principal: WorkflowExecutionDelegatedPrincipal,
+  principal: BoundWorkflowExecutionDelegatedPrincipal,
   signal: AbortSignal
 ): Promise<WindchillRouteOutput> {
   const documentUrl = windchillDocumentUrl(body.baseUrl, body.documentOid)
@@ -562,7 +565,7 @@ async function executeDownload(
 export const POST = withRouteHandler(
   async (request: NextRequest) => {
     const requestId = generateRequestId()
-    let principal: WorkflowExecutionDelegatedPrincipal
+    let principal: BoundWorkflowExecutionDelegatedPrincipal
     try {
       principal = await authenticateWindchillExecutor(request)
     } catch (error) {
@@ -603,7 +606,11 @@ export const POST = withRouteHandler(
           body.operation === 'windchill_upload_primary_content'
             ? [body.primaryFile]
             : body.attachmentFiles
-        const files = await loadUploadFiles(inputs, principal.subjectUserId, requestId)
+        const files = await loadUploadFiles(
+          inputs,
+          requirePrincipalSubjectUserId(principal),
+          requestId
+        )
         if (files instanceof NextResponse) return files
         const uploadedFileNames = await uploadWindchillContent({
           params: body,

apps/sim/app/api/v2/workflows/[workflowId]/execute/route.ts

@@ -363,8 +363,17 @@ export const POST = withRouteHandler(
             `Unexpected workflow authorization status: ${workflowAuthorization.status}`
           )
         }
+        if (!workflowAuthorization.workflow.workspaceId) {
+          throw new Error(`Workflow ${workflowId} has no workspace`)
+        }
         result = await executeWorkflowService({
           workflowId,
+          principal: {
+            kind: 'system',
+            serviceId: 'public_api',
+            workspaceId: workflowAuthorization.workflow.workspaceId,
+            workflowId,
+          },
           userId: publicApiUserId,
           isPublicApiAccess,
           input: body.input ?? {},

apps/sim/app/api/workflows/[id]/execute/route.async.test.ts

@@ -255,13 +255,32 @@ interface ExecutionCallerCase {
   isPublic?: boolean
 }
 
+const SESSION_PRINCIPAL = {
+  kind: 'session',
+  userId: 'session-user-1',
+  sessionId: 'session-1',
+} as const
+
+const PERSONAL_API_KEY_PRINCIPAL = {
+  kind: 'personal_api_key',
+  userId: 'personal-key-user-1',
+  keyId: 'personal-key-1',
+} as const
+
+const WORKSPACE_API_KEY_PRINCIPAL = {
+  kind: 'workspace_api_key',
+  workspaceId: 'workspace-1',
+  keyId: 'workspace-key-1',
+} as const
+
 const EXECUTION_CALLERS: ExecutionCallerCase[] = [
   {
     caseName: 'session',
     authResult: {
       success: true,
       userId: 'session-user-1',
       authType: 'session',
+      principal: SESSION_PRINCIPAL,
     },
     headers: { Cookie: 'session=value' },
     usesExternalInput: false,
@@ -273,6 +292,7 @@ const EXECUTION_CALLERS: ExecutionCallerCase[] = [
       userId: 'personal-key-user-1',
       authType: 'api_key',
       apiKeyType: 'personal',
+      principal: PERSONAL_API_KEY_PRINCIPAL,
     },
     headers: { 'X-API-Key': 'personal-key' },
     usesExternalInput: true,
@@ -285,6 +305,7 @@ const EXECUTION_CALLERS: ExecutionCallerCase[] = [
       workspaceId: 'workspace-1',
       authType: 'api_key',
       apiKeyType: 'workspace',
+      principal: WORKSPACE_API_KEY_PRINCIPAL,
     },
     headers: { 'X-API-Key': 'workspace-key' },
     usesExternalInput: true,
@@ -458,6 +479,7 @@ describe('workflow execute async route', () => {
       success: true,
       userId: 'session-user-1',
       authType: 'session',
+      principal: SESSION_PRINCIPAL,
     })
 
     mockAuthorizeWorkflowByWorkspacePermission.mockResolvedValue({
@@ -1309,6 +1331,7 @@ describe('workflow execute async route', () => {
       userId: 'personal-key-user-1',
       authType: 'api_key',
       apiKeyType: 'personal',
+      principal: PERSONAL_API_KEY_PRINCIPAL,
     })
     const response = await POST(
       createMockRequest(
@@ -2677,6 +2700,11 @@ describe('workflow execute async route', () => {
       userId: 'api-user-1',
       authType: 'api_key',
       apiKeyType: 'personal',
+      principal: {
+        kind: 'personal_api_key',
+        userId: 'api-user-1',
+        keyId: 'personal-key-1',
+      },
     })
     workflowsUtilsMockFns.mockWorkflowHasResponseBlock.mockReturnValueOnce(true)
     workflowsUtilsMockFns.mockCreateHttpResponseFromBlock.mockResolvedValueOnce(