@celigo/api-specs 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +119 -0
  3. package/dist/account.yml +592 -0
  4. package/dist/agent.yml +908 -0
  5. package/dist/ai-agent.yml +5471 -0
  6. package/dist/api.yml +4140 -0
  7. package/dist/apim.yml +1286 -0
  8. package/dist/asynchelper.yml +3391 -0
  9. package/dist/audit.yml +2006 -0
  10. package/dist/connection.yml +8665 -0
  11. package/dist/connector.yml +1406 -0
  12. package/dist/ediprofile.yml +911 -0
  13. package/dist/editransaction.yml +1210 -0
  14. package/dist/enduser.yml +1724 -0
  15. package/dist/environment.yml +568 -0
  16. package/dist/eventreport.yml +692 -0
  17. package/dist/export.yml +17610 -0
  18. package/dist/filedefinition.yml +1396 -0
  19. package/dist/filestorage.yml +3102 -0
  20. package/dist/flow.yml +7928 -0
  21. package/dist/guardrail.yml +2763 -0
  22. package/dist/httpconnector.yml +2277 -0
  23. package/dist/httpconnectorendpoint.yml +722 -0
  24. package/dist/httpconnectorresource.yml +396 -0
  25. package/dist/iclient.yml +4452 -0
  26. package/dist/import.yml +15381 -0
  27. package/dist/integration.yml +4406 -0
  28. package/dist/job.yml +2014 -0
  29. package/dist/lookupcache.yml +1325 -0
  30. package/dist/marketplace.yml +685 -0
  31. package/dist/mcp-oauth-provider.yml +590 -0
  32. package/dist/mcp-server.yml +2656 -0
  33. package/dist/notification.yml +488 -0
  34. package/dist/processor.yml +1253 -0
  35. package/dist/profile.yml +455 -0
  36. package/dist/recyclebin.yml +768 -0
  37. package/dist/script.yml +1128 -0
  38. package/dist/stack.yml +1291 -0
  39. package/dist/state.yml +894 -0
  40. package/dist/subscription.yml +1405 -0
  41. package/dist/sync.yml +4857 -0
  42. package/dist/tag.yml +553 -0
  43. package/dist/template.yml +897 -0
  44. package/dist/tool.yml +33656 -0
  45. package/dist/tradingpartnerconnector.yml +1490 -0
  46. package/dist/user.yml +831 -0
  47. package/package.json +41 -0
  48. package/schemas.json +8420 -0
package/dist/audit.yml ADDED
@@ -0,0 +1,2006 @@
1
+ openapi: 3.2.0
2
+ info:
3
+ version: 1.0.0
4
+ title: Audit Logs
5
+ description: API for querying Celigo audit logs — the append-only record of configuration changes and account events.
6
+ servers:
7
+ - url: https://api.integrator.io
8
+ description: Production (US / default region)
9
+ - url: https://api.eu.integrator.io
10
+ description: Production (EU region)
11
+ - url: https://api.au.integrator.io
12
+ description: Production (AU region)
13
+ - url: https://api.ca.integrator.io
14
+ description: Production (CA region)
15
+ security:
16
+ - bearerAuth: []
17
+ tags:
18
+ - name: Audit Logs
19
+ description: |-
20
+ Audit logs are an append-only record of every configuration change and
21
+ account event in Celigo. Each entry captures who performed an action,
22
+ what resource was affected, when it happened, and what changed — down
23
+ to field-level diffs for updates. Use them for compliance, change
24
+ tracking, and troubleshooting.
25
+
26
+ Notes:
27
+ - History is retained for a minimum of one year.
28
+ - Sensitive values (tokens, passwords) appear masked as `******`.
29
+ - CSV downloads are capped at ~20,000 rows per file; use `hasMore` to paginate.
30
+ - `byUser` is populated at read time — it reflects the user's current name and email, not the values at the time of the action.
31
+
32
+ ## Audit entry schema
33
+
34
+ {% openapi-schemas spec="audit" schemas="AuditEntry" grouped="true" %}
35
+ paths:
36
+ /v1/audit:
37
+ get:
38
+ x-internal: false
39
+ summary: Query audit logs
40
+ operationId: getAuditLogs
41
+ tags:
42
+ - Audit Logs
43
+ description: |-
44
+ Search audit log entries across all resources in the current account.
45
+ Use this to answer "what changed?" across the account — filter by resource
46
+ type, user, source, action, or time range. Results are ordered newest-first.
47
+
48
+ Filtering by `resourceType` + `_resourceId` returns entries for that
49
+ exact resource only — to include descendants (e.g. an integration's
50
+ flows and exports), use `GET /v1/{resourceType}/{_id}/audit` instead.
51
+ `_resourceId` requires `resourceType` to also be set.
52
+ parameters:
53
+ - name: limit
54
+ in: query
55
+ required: false
56
+ schema:
57
+ type: integer
58
+ minimum: 1
59
+ maximum: 1000
60
+ default: 1000
61
+ examples:
62
+ - 100
63
+ description: Maximum number of audit entries to return.
64
+ - name: after
65
+ in: query
66
+ required: false
67
+ description: |-
68
+ Opaque pagination cursor for the next page. Take it from the `after` value in the `Link`
69
+ response header's `rel="next"` URL rather than constructing it.
70
+ schema:
71
+ type: string
72
+ examples:
73
+ - W3siJGRhdGUiOiIyMDI2LTA1LTAxVDAwOjAwOjAwLjAwMFoifSwiNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwIl0
74
+ - name: resourceType
75
+ in: query
76
+ required: false
77
+ schema:
78
+ type: string
79
+ enum:
80
+ - accesstoken
81
+ - agent
82
+ - api
83
+ - ashare
84
+ - asynchelper
85
+ - connection
86
+ - dataset
87
+ - ediprofile
88
+ - environment
89
+ - export
90
+ - file
91
+ - filedefinition
92
+ - flow
93
+ - folder
94
+ - group
95
+ - iclient
96
+ - idpconfig
97
+ - import
98
+ - integration
99
+ - lookupcache
100
+ - mcpoauthprovider
101
+ - mcpserver
102
+ - notification
103
+ - revision
104
+ - role
105
+ - script
106
+ - ssoclient
107
+ - stack
108
+ - supportshare
109
+ - sync
110
+ - tool
111
+ - user
112
+ examples:
113
+ - connection
114
+ x-enumDescriptions:
115
+ accesstoken: API access token resource.
116
+ agent: On-premise agent resource.
117
+ api: Custom API endpoint resource.
118
+ ashare: Workspace user access record (account share) resource.
119
+ asynchelper: Async helper resource used for long-running operations.
120
+ connection: Connection resource for authenticating to external systems.
121
+ dataset: Dataset resource for data storage.
122
+ ediprofile: EDI profile resource for trading partner interchange configuration.
123
+ environment: Environment variable resource.
124
+ export: Export resource for reading data from a source system.
125
+ file: Celigo Storage file resource.
126
+ filedefinition: File definition resource for parsing structured files.
127
+ flow: Flow resource for data integration pipelines.
128
+ folder: Celigo Storage folder resource.
129
+ group: End-user group resource.
130
+ iclient: iClient shared credential resource.
131
+ idpconfig: End-user identity provider configuration resource.
132
+ import: Import resource for writing data to a destination system.
133
+ integration: Integration workspace resource.
134
+ lookupcache: Lookup cache resource for in-memory key-value stores.
135
+ mcpoauthprovider: MCP OAuth provider resource.
136
+ mcpserver: MCP server resource for AI agent tool hosting.
137
+ notification: Notification subscription resource.
138
+ revision: Revision snapshot resource for version control.
139
+ role: End-user role resource.
140
+ script: Script resource for custom JavaScript hooks.
141
+ ssoclient: SSO client configuration resource.
142
+ stack: Stack resource for on-premise or Lambda execution environments.
143
+ supportshare: Support share access grant resource.
144
+ sync: Sync resource.
145
+ tool: Tool resource for reusable building blocks.
146
+ user: User access record resource.
147
+ description: |-
148
+ Filter by resource type (singular form). Unsupported values are
149
+ rejected with 422 `audit_not_supported`.
150
+ - name: _resourceId
151
+ in: query
152
+ required: false
153
+ schema:
154
+ type: string
155
+ format: objectId
156
+ examples:
157
+ - 60a2c4e6f321d800129a1a3c
158
+ description: Filter by a specific resource id. Requires `resourceType` to also be set.
159
+ - name: _byUserId
160
+ in: query
161
+ required: false
162
+ description: Filter by user id, or pass `support` to filter actions performed by Celigo support.
163
+ schema:
164
+ type: string
165
+ x-celigo-refModel: users
166
+ examples:
167
+ - 624cb0346309dc3a543733a2
168
+ - name: source
169
+ in: query
170
+ required: false
171
+ schema:
172
+ type: string
173
+ enum:
174
+ - ui
175
+ - api
176
+ - system
177
+ - connector
178
+ - script
179
+ - stack
180
+ - sso
181
+ - cli
182
+ - mcp
183
+ - ora
184
+ examples:
185
+ - ui
186
+ x-enumDescriptions:
187
+ ui: Change made through the Celigo web UI.
188
+ api: Change made via the REST API.
189
+ system: Change made automatically by the platform.
190
+ connector: Change made by an Integration App (connector) process.
191
+ script: Change made by a custom script execution.
192
+ stack: Change made by extension code hosted on a stack.
193
+ sso: Change triggered by an SSO authentication event.
194
+ cli: Change made via the Celigo CLI.
195
+ mcp: Change made through the Celigo Platform MCP server.
196
+ ora: Change made by the Ora AI assistant.
197
+ description: |-
198
+ Filter by source. Unsupported values are rejected with 422
199
+ `invalid_audit_field`.
200
+ - name: fieldPath
201
+ in: query
202
+ required: false
203
+ schema:
204
+ type: string
205
+ examples:
206
+ - http.auth.token.token
207
+ description: |-
208
+ Restrict the `fieldChanges` of returned entries to changes on this
209
+ field path. The value is not validated against known paths — an
210
+ unknown path simply matches nothing.
211
+ - name: action
212
+ in: query
213
+ required: false
214
+ schema:
215
+ type: string
216
+ enum:
217
+ - create
218
+ - update
219
+ - delete
220
+ - view
221
+ - restore
222
+ - purge
223
+ - signin
224
+ - signout
225
+ - purgelogs
226
+ examples:
227
+ - update
228
+ x-enumDescriptions:
229
+ create: A resource was created.
230
+ update: A resource was modified.
231
+ delete: A resource was deleted (moved to recycle bin).
232
+ view: A resource was viewed or accessed.
233
+ restore: A resource was restored from the recycle bin.
234
+ purge: A resource was permanently purged from the recycle bin.
235
+ signin: A user signed in to the account.
236
+ signout: A user signed out of the account.
237
+ purgelogs: Execution logs were purged for a resource.
238
+ description: Filter by action/event.
239
+ - name: from
240
+ in: query
241
+ required: false
242
+ schema:
243
+ type: string
244
+ format: date-time
245
+ examples:
246
+ - '2025-01-01T00:00:00.000Z'
247
+ description: Start timestamp (ISO-8601).
248
+ - name: to
249
+ in: query
250
+ required: false
251
+ schema:
252
+ type: string
253
+ format: date-time
254
+ examples:
255
+ - '2025-12-31T23:59:59.999Z'
256
+ description: End timestamp (ISO-8601).
257
+ responses:
258
+ '200':
259
+ description: Audit entries
260
+ headers:
261
+ Link:
262
+ description: |-
263
+ RFC 5988 pagination link. Includes `<...>; rel="next"` with an
264
+ `after` cursor when more entries exist; absent on the final page.
265
+ schema:
266
+ type: string
267
+ content:
268
+ application/json:
269
+ schema:
270
+ type: array
271
+ items:
272
+ $ref: '#/components/schemas/AuditEntry'
273
+ examples:
274
+ default:
275
+ value:
276
+ - _id: 69fe3b7833f18c171d7e91b9
277
+ resourceType: connection
278
+ _resourceId: 69497ca1b40d3e24522a7f3c
279
+ source: system
280
+ fieldChanges:
281
+ - fieldPath: http.auth.token.token
282
+ oldValue: '******'
283
+ newValue: '******'
284
+ event: update
285
+ time: '2026-05-08T19:37:27.436Z'
286
+ byUser:
287
+ _id: 624cb0346309dc3a543733a2
288
+ email: jane.doe@example.com
289
+ name: Jane Doe
290
+ - _id: 69f6367c3469e3f559a8cac9
291
+ resourceType: connection
292
+ _resourceId: 69f6367b3469e3f559a8cabf
293
+ source: api
294
+ fieldChanges: []
295
+ event: create
296
+ time: '2026-05-02T17:38:04.021Z'
297
+ deletedInfo:
298
+ name: My HTTP Connection
299
+ byUser:
300
+ _id: 624cb0346309dc3a543733a2
301
+ email: jane.doe@example.com
302
+ name: Jane Doe
303
+ '204':
304
+ description: No audit entries found
305
+ '400':
306
+ $ref: '#/components/responses/400-bad-request'
307
+ '401':
308
+ $ref: '#/components/responses/401-unauthorized'
309
+ '422':
310
+ $ref: '#/components/responses/422-unprocessable-entity'
311
+ post:
312
+ x-internal: false
313
+ summary: Query audit logs with multi-select filters
314
+ operationId: queryAuditLogs
315
+ tags:
316
+ - Audit Logs
317
+ description: |-
318
+ The POST variant of the account-wide audit query, for filters the GET
319
+ query string cannot express: each body filter is an array that matches
320
+ entries with any of the listed values, and `resourceName` scopes results
321
+ to an explicit list of resources. Response shape and ordering are
322
+ identical to `GET /v1/audit`.
323
+
324
+ Pagination, sorting, and time bounds stay in the query string — sending
325
+ them in the body fails with 400 `invalid_request_body`.
326
+ parameters:
327
+ - name: limit
328
+ in: query
329
+ required: false
330
+ schema:
331
+ type: integer
332
+ minimum: 1
333
+ maximum: 1000
334
+ default: 1000
335
+ examples:
336
+ - 100
337
+ description: Maximum number of audit entries to return.
338
+ - name: after
339
+ in: query
340
+ required: false
341
+ description: |-
342
+ Opaque pagination cursor for the next page. Take it from the `after` value in the `Link`
343
+ response header's `rel="next"` URL rather than constructing it. Mutually exclusive
344
+ with `before`.
345
+ schema:
346
+ type: string
347
+ examples:
348
+ - W3siJGRhdGUiOiIyMDI2LTA1LTAxVDAwOjAwOjAwLjAwMFoifSwiNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwIl0
349
+ - name: before
350
+ in: query
351
+ required: false
352
+ description: |-
353
+ Opaque pagination cursor for the previous page, from the `Link` response
354
+ header. Mutually exclusive with `after` — sending both returns 422.
355
+ schema:
356
+ type: string
357
+ - name: sort_by
358
+ in: query
359
+ required: false
360
+ description: Field to sort by. Only `time` is accepted; other values return 422.
361
+ schema:
362
+ type: string
363
+ enum:
364
+ - time
365
+ default: time
366
+ x-enumDescriptions:
367
+ time: Sort by the entry timestamp.
368
+ - name: sort_order
369
+ in: query
370
+ required: false
371
+ description: Sort direction for `time`.
372
+ schema:
373
+ type: string
374
+ enum:
375
+ - asc
376
+ - desc
377
+ default: desc
378
+ x-enumDescriptions:
379
+ asc: Oldest entries first.
380
+ desc: Newest entries first.
381
+ - name: from
382
+ in: query
383
+ required: false
384
+ schema:
385
+ type: string
386
+ format: date-time
387
+ examples:
388
+ - '2025-01-01T00:00:00.000Z'
389
+ description: Start timestamp (ISO-8601).
390
+ - name: to
391
+ in: query
392
+ required: false
393
+ schema:
394
+ type: string
395
+ format: date-time
396
+ examples:
397
+ - '2025-12-31T23:59:59.999Z'
398
+ description: End timestamp (ISO-8601).
399
+ requestBody:
400
+ required: true
401
+ content:
402
+ application/json:
403
+ schema:
404
+ $ref: '#/components/schemas/AuditQueryFilters'
405
+ examples:
406
+ multi-select:
407
+ summary: Connection and agent creates/updates
408
+ value:
409
+ resourceType:
410
+ - connection
411
+ - agent
412
+ action:
413
+ - create
414
+ - update
415
+ by-source:
416
+ summary: Entries from API or system activity
417
+ value:
418
+ source:
419
+ - api
420
+ - system
421
+ responses:
422
+ '200':
423
+ description: Audit entries
424
+ headers:
425
+ Link:
426
+ description: |-
427
+ RFC 5988 pagination link. Includes `<...>; rel="next"` with an
428
+ `after` cursor when more entries exist; absent on the final page.
429
+ schema:
430
+ type: string
431
+ content:
432
+ application/json:
433
+ schema:
434
+ type: array
435
+ items:
436
+ $ref: '#/components/schemas/AuditEntry'
437
+ examples:
438
+ default:
439
+ value:
440
+ - _id: 69fe3b7833f18c171d7e91b9
441
+ resourceType: connection
442
+ _resourceId: 69497ca1b40d3e24522a7f3c
443
+ source: api
444
+ fieldChanges:
445
+ - fieldPath: http.auth.token.token
446
+ oldValue: '******'
447
+ newValue: '******'
448
+ event: update
449
+ time: '2026-05-08T19:37:27.436Z'
450
+ byUser:
451
+ _id: 624cb0346309dc3a543733a2
452
+ email: jane.doe@example.com
453
+ name: Jane Doe
454
+ '204':
455
+ description: No audit entries match the filters.
456
+ '400':
457
+ description: Pagination parameters were sent in the request body.
458
+ content:
459
+ application/json:
460
+ schema:
461
+ $ref: '#/components/schemas/Error'
462
+ examples:
463
+ pagination_in_body:
464
+ value:
465
+ errors:
466
+ - code: invalid_request_body
467
+ message: 'The request body should not contain pagination parameter(s): limit. Pagination values (after, before, limit, sort_order, sort_by) must be provided as query parameters. The request body should only contain filter fields.'
468
+ '401':
469
+ $ref: '#/components/responses/401-unauthorized'
470
+ '422':
471
+ description: |-
472
+ A filter value is invalid, a filter that must be an array was sent as
473
+ another type, or the `after`/`before` cursor is malformed.
474
+ content:
475
+ application/json:
476
+ schema:
477
+ $ref: '#/components/schemas/Error'
478
+ examples:
479
+ invalid_value:
480
+ value:
481
+ errors:
482
+ - code: invalid_audit_field
483
+ message: zzz is not a valid audit source.
484
+ not_an_array:
485
+ value:
486
+ errors:
487
+ - code: invalid_field_type
488
+ message: The "source" field must be an array when provided in the request body.
489
+ /v1/audit/signedURL:
490
+ get:
491
+ x-internal: false
492
+ summary: Get signed URL to download audit logs CSV (all documents)
493
+ operationId: getAuditSignedUrlAll
494
+ tags:
495
+ - Audit Logs
496
+ description: |-
497
+ Generates a signed URL for downloading a CSV export of audit logs across all
498
+ documents. The CSV columns are: Time, Source, User, Resource, Name/ID, Action,
499
+ Field, Old value, New value, Support.
500
+
501
+ The signed URL expires after 15 minutes. When `hasMore` is true, pass
502
+ the last CSV row's timestamp as `to` to fetch the next batch.
503
+ parameters:
504
+ - name: resourceType
505
+ in: query
506
+ required: false
507
+ schema:
508
+ type: string
509
+ enum:
510
+ - accesstoken
511
+ - agent
512
+ - api
513
+ - ashare
514
+ - asynchelper
515
+ - connection
516
+ - dataset
517
+ - ediprofile
518
+ - environment
519
+ - export
520
+ - file
521
+ - filedefinition
522
+ - flow
523
+ - folder
524
+ - group
525
+ - iclient
526
+ - idpconfig
527
+ - import
528
+ - integration
529
+ - lookupcache
530
+ - mcpoauthprovider
531
+ - mcpserver
532
+ - notification
533
+ - revision
534
+ - role
535
+ - script
536
+ - ssoclient
537
+ - stack
538
+ - supportshare
539
+ - sync
540
+ - tool
541
+ - user
542
+ x-enumDescriptions:
543
+ accesstoken: API access token resource.
544
+ agent: On-premise agent resource.
545
+ api: Custom API endpoint resource.
546
+ ashare: Workspace user access record (account share) resource.
547
+ asynchelper: Async helper resource used for long-running operations.
548
+ connection: Connection resource for authenticating to external systems.
549
+ dataset: Dataset resource for data storage.
550
+ ediprofile: EDI profile resource for trading partner interchange configuration.
551
+ environment: Environment variable resource.
552
+ export: Export resource for reading data from a source system.
553
+ file: Celigo Storage file resource.
554
+ filedefinition: File definition resource for parsing structured files.
555
+ flow: Flow resource for data integration pipelines.
556
+ folder: Celigo Storage folder resource.
557
+ group: End-user group resource.
558
+ iclient: iClient shared credential resource.
559
+ idpconfig: End-user identity provider configuration resource.
560
+ import: Import resource for writing data to a destination system.
561
+ integration: Integration workspace resource.
562
+ lookupcache: Lookup cache resource for in-memory key-value stores.
563
+ mcpoauthprovider: MCP OAuth provider resource.
564
+ mcpserver: MCP server resource for AI agent tool hosting.
565
+ notification: Notification subscription resource.
566
+ revision: Revision snapshot resource for version control.
567
+ role: End-user role resource.
568
+ script: Script resource for custom JavaScript hooks.
569
+ ssoclient: SSO client configuration resource.
570
+ stack: Stack resource for on-premise or Lambda execution environments.
571
+ supportshare: Support share access grant resource.
572
+ sync: Sync resource.
573
+ tool: Tool resource for reusable building blocks.
574
+ user: User access record resource.
575
+ description: Optional filter by resource type (singular form).
576
+ - name: _byUserId
577
+ in: query
578
+ required: false
579
+ schema:
580
+ type: string
581
+ x-celigo-refModel: users
582
+ examples:
583
+ - 624cb0346309dc3a543733a2
584
+ description: Optional filter by the user who performed the actions.
585
+ - name: _resourceId
586
+ in: query
587
+ required: false
588
+ schema:
589
+ type: string
590
+ format: objectId
591
+ examples:
592
+ - 60a2c4e6f321d800129a1a3c
593
+ description: Optional filter by resource id.
594
+ - name: from
595
+ in: query
596
+ required: false
597
+ schema:
598
+ type: string
599
+ format: date-time
600
+ examples:
601
+ - '2025-01-01T00:00:00.000Z'
602
+ description: Start timestamp (ISO-8601).
603
+ - name: to
604
+ in: query
605
+ required: false
606
+ schema:
607
+ type: string
608
+ format: date-time
609
+ examples:
610
+ - '2025-12-31T23:59:59.999Z'
611
+ description: End timestamp (ISO-8601).
612
+ - name: action
613
+ in: query
614
+ required: false
615
+ schema:
616
+ type: string
617
+ enum:
618
+ - create
619
+ - update
620
+ - delete
621
+ - view
622
+ - restore
623
+ - purge
624
+ - signin
625
+ - signout
626
+ - purgelogs
627
+ x-enumDescriptions:
628
+ create: A resource was created.
629
+ update: A resource was modified.
630
+ delete: A resource was deleted (moved to recycle bin).
631
+ view: A resource was viewed or accessed.
632
+ restore: A resource was restored from the recycle bin.
633
+ purge: A resource was permanently purged from the recycle bin.
634
+ signin: A user signed in to the account.
635
+ signout: A user signed out of the account.
636
+ purgelogs: Execution logs were purged for a resource.
637
+ description: Action/event filter.
638
+ - name: source
639
+ in: query
640
+ required: false
641
+ schema:
642
+ type: string
643
+ enum:
644
+ - ui
645
+ - api
646
+ - system
647
+ - connector
648
+ - script
649
+ - stack
650
+ - sso
651
+ - cli
652
+ - mcp
653
+ - ora
654
+ x-enumDescriptions:
655
+ ui: Change made through the Celigo web UI.
656
+ api: Change made via the REST API.
657
+ system: Change made automatically by the platform.
658
+ connector: Change made by an Integration App (connector) process.
659
+ script: Change made by a custom script execution.
660
+ stack: Change made by extension code hosted on a stack.
661
+ sso: Change triggered by an SSO authentication event.
662
+ cli: Change made via the Celigo CLI.
663
+ mcp: Change made through the Celigo Platform MCP server.
664
+ ora: Change made by the Ora AI assistant.
665
+ description: Source filter.
666
+ responses:
667
+ '200':
668
+ description: Signed URL response
669
+ content:
670
+ application/json:
671
+ schema:
672
+ $ref: '#/components/schemas/SignedUrlResponse'
673
+ examples:
674
+ default:
675
+ value:
676
+ signedURL: https://integrator-userdata-delete-30.s3.us-east-1.amazonaws.com/audit/624cb034630.../audit-export.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=900&...
677
+ hasMore: false
678
+ '401':
679
+ $ref: '#/components/responses/401-unauthorized'
680
+ '422':
681
+ $ref: '#/components/responses/422-unprocessable-entity'
682
+ post:
683
+ x-internal: false
684
+ summary: Get signed URL for audit CSV with multi-select filters
685
+ operationId: queryAuditSignedUrlAll
686
+ tags:
687
+ - Audit Logs
688
+ description: |-
689
+ The POST variant of the CSV signed-URL download, accepting the same
690
+ multi-select filter body as `POST /v1/audit`. The response is identical
691
+ to the GET variant: a signed URL valid for ~15 minutes plus `hasMore`
692
+ for batching.
693
+
694
+ Sorting and time bounds stay in the query string — sending `from`/`to`
695
+ or pagination keys in the body fails with 400.
696
+ parameters:
697
+ - name: sort_order
698
+ in: query
699
+ required: false
700
+ description: Sort direction for the CSV rows by time.
701
+ schema:
702
+ type: string
703
+ enum:
704
+ - asc
705
+ - desc
706
+ default: desc
707
+ x-enumDescriptions:
708
+ asc: Oldest entries first.
709
+ desc: Newest entries first.
710
+ - name: from
711
+ in: query
712
+ required: false
713
+ schema:
714
+ type: string
715
+ format: date-time
716
+ examples:
717
+ - '2025-01-01T00:00:00.000Z'
718
+ description: Start timestamp (ISO-8601).
719
+ - name: to
720
+ in: query
721
+ required: false
722
+ schema:
723
+ type: string
724
+ format: date-time
725
+ examples:
726
+ - '2025-12-31T23:59:59.999Z'
727
+ description: End timestamp (ISO-8601).
728
+ requestBody:
729
+ required: true
730
+ content:
731
+ application/json:
732
+ schema:
733
+ $ref: '#/components/schemas/AuditQueryFilters'
734
+ examples:
735
+ by-source:
736
+ summary: CSV of API-sourced changes
737
+ value:
738
+ source:
739
+ - api
740
+ responses:
741
+ '200':
742
+ description: Signed URL response
743
+ content:
744
+ application/json:
745
+ schema:
746
+ $ref: '#/components/schemas/SignedUrlResponse'
747
+ examples:
748
+ default:
749
+ value:
750
+ signedURL: https://integrator-userdata-delete-30.s3.us-east-1.amazonaws.com/audit/624cb034630.../audit-export.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=900&...
751
+ hasMore: false
752
+ '400':
753
+ description: Pagination or time-bound parameters were sent in the request body.
754
+ content:
755
+ application/json:
756
+ schema:
757
+ $ref: '#/components/schemas/Error'
758
+ '401':
759
+ $ref: '#/components/responses/401-unauthorized'
760
+ '422':
761
+ $ref: '#/components/responses/422-unprocessable-entity'
762
+ /v1/{resourceType}/{_id}/audit:
763
+ get:
764
+ x-internal: false
765
+ summary: Get audit log for a resource (and descendants)
766
+ operationId: getAuditForResource
767
+ tags:
768
+ - Audit Logs
769
+ description: |-
770
+ Returns audit log entries for a specific resource and its descendants. For example,
771
+ querying an integration returns changes to the integration, its flows, exports,
772
+ imports, and connections.
773
+
774
+ For account-wide searches, use `GET /v1/audit` instead.
775
+ parameters:
776
+ - name: resourceType
777
+ in: path
778
+ required: true
779
+ schema:
780
+ type: string
781
+ enum:
782
+ - accesstokens
783
+ - agents
784
+ - apis
785
+ - asynchelpers
786
+ - connections
787
+ - ediprofiles
788
+ - exports
789
+ - filedefinitions
790
+ - flows
791
+ - groups
792
+ - iclients
793
+ - idpconfigs
794
+ - imports
795
+ - integrations
796
+ - lookupcaches
797
+ - mcpoauthproviders
798
+ - mcpservers
799
+ - revisions
800
+ - roles
801
+ - scripts
802
+ - ssoclients
803
+ - stacks
804
+ - syncs
805
+ - tools
806
+ examples:
807
+ - integrations
808
+ x-enumDescriptions:
809
+ accesstokens: API access token resources.
810
+ agents: On-premise agent resources.
811
+ apis: Custom API endpoint resources.
812
+ asynchelpers: Async helper resources.
813
+ connections: Connection resources.
814
+ ediprofiles: EDI profile resources.
815
+ exports: Export resources.
816
+ filedefinitions: File definition resources.
817
+ flows: Flow resources.
818
+ groups: End-user group resources.
819
+ iclients: iClient shared credential resources.
820
+ idpconfigs: End-user identity provider configuration resources.
821
+ imports: Import resources.
822
+ integrations: Integration workspace resources.
823
+ lookupcaches: Lookup cache resources.
824
+ mcpoauthproviders: MCP OAuth provider resources.
825
+ mcpservers: MCP server resources.
826
+ revisions: Revision snapshot resources.
827
+ roles: End-user role resources.
828
+ scripts: Script resources.
829
+ ssoclients: SSO client configuration resources.
830
+ stacks: Stack resources.
831
+ syncs: Sync resources.
832
+ tools: Tool resources.
833
+ description: Plural resource type.
834
+ - name: _id
835
+ in: path
836
+ required: true
837
+ description: Resource id.
838
+ schema:
839
+ type: string
840
+ format: objectId
841
+ examples:
842
+ - 60a2c4e6f321d800129a1a3c
843
+ - name: limit
844
+ in: query
845
+ required: false
846
+ description: Maximum number of audit entries to return.
847
+ schema:
848
+ type: integer
849
+ minimum: 1
850
+ maximum: 1000
851
+ default: 1000
852
+ examples:
853
+ - 100
854
+ - name: after
855
+ in: query
856
+ required: false
857
+ description: |-
858
+ Opaque pagination cursor for the next page. Take it from the `after` value in the `Link`
859
+ response header's `rel="next"` URL rather than constructing it.
860
+ schema:
861
+ type: string
862
+ examples:
863
+ - W3siJGRhdGUiOiIyMDI2LTA1LTAxVDAwOjAwOjAwLjAwMFoifSwiNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwIl0
864
+ - name: from
865
+ in: query
866
+ required: false
867
+ schema:
868
+ type: string
869
+ format: date-time
870
+ examples:
871
+ - '2025-01-01T00:00:00.000Z'
872
+ description: Start timestamp (ISO-8601).
873
+ - name: to
874
+ in: query
875
+ required: false
876
+ schema:
877
+ type: string
878
+ format: date-time
879
+ examples:
880
+ - '2025-12-31T23:59:59.999Z'
881
+ description: End timestamp (ISO-8601).
882
+ - name: action
883
+ in: query
884
+ required: false
885
+ schema:
886
+ type: string
887
+ enum:
888
+ - create
889
+ - update
890
+ - delete
891
+ - view
892
+ - restore
893
+ - purge
894
+ - signin
895
+ - signout
896
+ - purgelogs
897
+ examples:
898
+ - update
899
+ x-enumDescriptions:
900
+ create: A resource was created.
901
+ update: A resource was modified.
902
+ delete: A resource was deleted (moved to recycle bin).
903
+ view: A resource was viewed or accessed.
904
+ restore: A resource was restored from the recycle bin.
905
+ purge: A resource was permanently purged from the recycle bin.
906
+ signin: A user signed in to the account.
907
+ signout: A user signed out of the account.
908
+ purgelogs: Execution logs were purged for a resource.
909
+ description: Filter by action/event.
910
+ - name: source
911
+ in: query
912
+ required: false
913
+ schema:
914
+ type: string
915
+ enum:
916
+ - ui
917
+ - api
918
+ - system
919
+ - connector
920
+ - script
921
+ - stack
922
+ - sso
923
+ - cli
924
+ - mcp
925
+ - ora
926
+ examples:
927
+ - ui
928
+ x-enumDescriptions:
929
+ ui: Change made through the Celigo web UI.
930
+ api: Change made via the REST API.
931
+ system: Change made automatically by the platform.
932
+ connector: Change made by an Integration App (connector) process.
933
+ script: Change made by a custom script execution.
934
+ stack: Change made by extension code hosted on a stack.
935
+ sso: Change triggered by an SSO authentication event.
936
+ cli: Change made via the Celigo CLI.
937
+ mcp: Change made through the Celigo Platform MCP server.
938
+ ora: Change made by the Ora AI assistant.
939
+ description: Filter by source.
940
+ - name: _byUserId
941
+ in: query
942
+ required: false
943
+ schema:
944
+ type: string
945
+ x-celigo-refModel: users
946
+ examples:
947
+ - 624cb0346309dc3a543733a2
948
+ description: Filter by the user who performed the action.
949
+ responses:
950
+ '200':
951
+ description: Audit entries
952
+ headers:
953
+ Link:
954
+ description: |-
955
+ RFC 5988 pagination link. Includes `<...>; rel="next"` with an
956
+ `after` cursor when more entries exist; absent on the final page.
957
+ schema:
958
+ type: string
959
+ content:
960
+ application/json:
961
+ schema:
962
+ type: array
963
+ items:
964
+ $ref: '#/components/schemas/AuditEntry'
965
+ examples:
966
+ default:
967
+ value:
968
+ - _id: 69f63df97009ea11abf0cb97
969
+ resourceType: ediprofile
970
+ _resourceId: 690146d901d66a7545038179
971
+ source: api
972
+ fieldChanges:
973
+ - fieldPath: tpInterchangeId
974
+ oldValue: 9253390501 test
975
+ newValue: '9253390501'
976
+ event: update
977
+ time: '2026-05-02T18:10:01.832Z'
978
+ byUser:
979
+ _id: 624cb0346309dc3a543733a2
980
+ email: jane.doe@example.com
981
+ name: Jane Doe
982
+ '204':
983
+ description: No audit entries found
984
+ '400':
985
+ $ref: '#/components/responses/400-bad-request'
986
+ '401':
987
+ $ref: '#/components/responses/401-unauthorized'
988
+ '404':
989
+ $ref: '#/components/responses/404-not-found'
990
+ '422':
991
+ $ref: '#/components/responses/422-unprocessable-entity'
992
+ post:
993
+ x-internal: false
994
+ summary: Query a resource's audit log with multi-select filters
995
+ operationId: queryAuditForResource
996
+ tags:
997
+ - Audit Logs
998
+ description: |-
999
+ The POST variant of the resource-and-descendants audit query, accepting
1000
+ the same multi-select filter body as `POST /v1/audit`. Body filters apply
1001
+ within the resource's descendant set — e.g. filter an integration's audit
1002
+ trail to specific actions or sources. Response shape matches the GET
1003
+ variant.
1004
+
1005
+ Pagination, sorting, and time bounds stay in the query string — sending
1006
+ them in the body fails with 400 `invalid_request_body`.
1007
+ parameters:
1008
+ - name: resourceType
1009
+ in: path
1010
+ required: true
1011
+ schema:
1012
+ type: string
1013
+ enum:
1014
+ - accesstokens
1015
+ - agents
1016
+ - apis
1017
+ - asynchelpers
1018
+ - connections
1019
+ - ediprofiles
1020
+ - exports
1021
+ - filedefinitions
1022
+ - flows
1023
+ - groups
1024
+ - iclients
1025
+ - idpconfigs
1026
+ - imports
1027
+ - integrations
1028
+ - lookupcaches
1029
+ - mcpoauthproviders
1030
+ - mcpservers
1031
+ - revisions
1032
+ - roles
1033
+ - scripts
1034
+ - ssoclients
1035
+ - stacks
1036
+ - syncs
1037
+ - tools
1038
+ examples:
1039
+ - integrations
1040
+ x-enumDescriptions:
1041
+ accesstokens: API access token resources.
1042
+ agents: On-premise agent resources.
1043
+ apis: Custom API endpoint resources.
1044
+ asynchelpers: Async helper resources.
1045
+ connections: Connection resources.
1046
+ ediprofiles: EDI profile resources.
1047
+ exports: Export resources.
1048
+ filedefinitions: File definition resources.
1049
+ flows: Flow resources.
1050
+ groups: End-user group resources.
1051
+ iclients: iClient shared credential resources.
1052
+ idpconfigs: End-user identity provider configuration resources.
1053
+ imports: Import resources.
1054
+ integrations: Integration workspace resources.
1055
+ lookupcaches: Lookup cache resources.
1056
+ mcpoauthproviders: MCP OAuth provider resources.
1057
+ mcpservers: MCP server resources.
1058
+ revisions: Revision snapshot resources.
1059
+ roles: End-user role resources.
1060
+ scripts: Script resources.
1061
+ ssoclients: SSO client configuration resources.
1062
+ stacks: Stack resources.
1063
+ syncs: Sync resources.
1064
+ tools: Tool resources.
1065
+ description: Plural resource type.
1066
+ - name: _id
1067
+ in: path
1068
+ required: true
1069
+ description: Resource id.
1070
+ schema:
1071
+ type: string
1072
+ format: objectId
1073
+ examples:
1074
+ - 60a2c4e6f321d800129a1a3c
1075
+ - name: limit
1076
+ in: query
1077
+ required: false
1078
+ description: Maximum number of audit entries to return.
1079
+ schema:
1080
+ type: integer
1081
+ minimum: 1
1082
+ maximum: 1000
1083
+ default: 1000
1084
+ examples:
1085
+ - 100
1086
+ - name: after
1087
+ in: query
1088
+ required: false
1089
+ description: |-
1090
+ Opaque pagination cursor for the next page. Take it from the `after` value in the `Link`
1091
+ response header's `rel="next"` URL rather than constructing it. Mutually exclusive
1092
+ with `before`.
1093
+ schema:
1094
+ type: string
1095
+ - name: before
1096
+ in: query
1097
+ required: false
1098
+ description: |-
1099
+ Opaque pagination cursor for the previous page, from the `Link` response
1100
+ header. Mutually exclusive with `after` — sending both returns 422.
1101
+ schema:
1102
+ type: string
1103
+ - name: sort_by
1104
+ in: query
1105
+ required: false
1106
+ description: Field to sort by. Only `time` is accepted; other values return 422.
1107
+ schema:
1108
+ type: string
1109
+ enum:
1110
+ - time
1111
+ default: time
1112
+ x-enumDescriptions:
1113
+ time: Sort by the entry timestamp.
1114
+ - name: sort_order
1115
+ in: query
1116
+ required: false
1117
+ description: Sort direction for `time`.
1118
+ schema:
1119
+ type: string
1120
+ enum:
1121
+ - asc
1122
+ - desc
1123
+ default: desc
1124
+ x-enumDescriptions:
1125
+ asc: Oldest entries first.
1126
+ desc: Newest entries first.
1127
+ - name: from
1128
+ in: query
1129
+ required: false
1130
+ schema:
1131
+ type: string
1132
+ format: date-time
1133
+ examples:
1134
+ - '2025-01-01T00:00:00.000Z'
1135
+ description: Start timestamp (ISO-8601).
1136
+ - name: to
1137
+ in: query
1138
+ required: false
1139
+ schema:
1140
+ type: string
1141
+ format: date-time
1142
+ examples:
1143
+ - '2025-12-31T23:59:59.999Z'
1144
+ description: End timestamp (ISO-8601).
1145
+ requestBody:
1146
+ required: true
1147
+ content:
1148
+ application/json:
1149
+ schema:
1150
+ $ref: '#/components/schemas/AuditQueryFilters'
1151
+ examples:
1152
+ actions:
1153
+ summary: Only creates and updates within this resource's tree
1154
+ value:
1155
+ action:
1156
+ - create
1157
+ - update
1158
+ responses:
1159
+ '200':
1160
+ description: Audit entries
1161
+ headers:
1162
+ Link:
1163
+ description: |-
1164
+ RFC 5988 pagination link. Includes `<...>; rel="next"` with an
1165
+ `after` cursor when more entries exist; absent on the final page.
1166
+ schema:
1167
+ type: string
1168
+ content:
1169
+ application/json:
1170
+ schema:
1171
+ type: array
1172
+ items:
1173
+ $ref: '#/components/schemas/AuditEntry'
1174
+ examples:
1175
+ default:
1176
+ value:
1177
+ - _id: 69f63df97009ea11abf0cb97
1178
+ resourceType: ediprofile
1179
+ _resourceId: 690146d901d66a7545038179
1180
+ source: api
1181
+ fieldChanges:
1182
+ - fieldPath: tpInterchangeId
1183
+ oldValue: 9253390501 test
1184
+ newValue: '9253390501'
1185
+ event: update
1186
+ time: '2026-05-02T18:10:01.832Z'
1187
+ byUser:
1188
+ _id: 624cb0346309dc3a543733a2
1189
+ email: jane.doe@example.com
1190
+ name: Jane Doe
1191
+ '204':
1192
+ description: No audit entries match the filters.
1193
+ '400':
1194
+ description: |-
1195
+ Pagination parameters were sent in the request body, or the path is
1196
+ invalid (`_id` malformed, or a resource type without audit support).
1197
+ content:
1198
+ application/json:
1199
+ schema:
1200
+ $ref: '#/components/schemas/Error'
1201
+ '401':
1202
+ $ref: '#/components/responses/401-unauthorized'
1203
+ '404':
1204
+ $ref: '#/components/responses/404-not-found'
1205
+ '422':
1206
+ description: |-
1207
+ A filter value is invalid, a filter that must be an array was sent as
1208
+ another type, or the `after`/`before` cursor is malformed.
1209
+ content:
1210
+ application/json:
1211
+ schema:
1212
+ $ref: '#/components/schemas/Error'
1213
+ /v1/{resourceType}/audit/signedURL:
1214
+ post:
1215
+ x-internal: false
1216
+ summary: Get signed URL to download audit logs CSV (for selected resources)
1217
+ operationId: getAuditSignedUrlForResources
1218
+ tags:
1219
+ - Audit Logs
1220
+ description: |-
1221
+ Generates a signed URL for downloading a CSV export of audit logs for specific
1222
+ resources and their descendants.
1223
+
1224
+ The signed URL expires after 15 minutes. When `hasMore` is true, pass
1225
+ the last CSV row's timestamp as `to` in the request body to fetch the
1226
+ next batch.
1227
+ parameters:
1228
+ - name: resourceType
1229
+ in: path
1230
+ required: true
1231
+ schema:
1232
+ type: string
1233
+ enum:
1234
+ - accesstokens
1235
+ - agents
1236
+ - apis
1237
+ - asynchelpers
1238
+ - connections
1239
+ - ediprofiles
1240
+ - exports
1241
+ - filedefinitions
1242
+ - flows
1243
+ - groups
1244
+ - iclients
1245
+ - idpconfigs
1246
+ - imports
1247
+ - integrations
1248
+ - lookupcaches
1249
+ - mcpoauthproviders
1250
+ - mcpservers
1251
+ - revisions
1252
+ - roles
1253
+ - scripts
1254
+ - ssoclients
1255
+ - stacks
1256
+ - syncs
1257
+ - tools
1258
+ x-enumDescriptions:
1259
+ accesstokens: API access token resources.
1260
+ agents: On-premise agent resources.
1261
+ apis: Custom API endpoint resources.
1262
+ asynchelpers: Async helper resources.
1263
+ connections: Connection resources.
1264
+ ediprofiles: EDI profile resources.
1265
+ exports: Export resources.
1266
+ filedefinitions: File definition resources.
1267
+ flows: Flow resources.
1268
+ groups: End-user group resources.
1269
+ iclients: iClient shared credential resources.
1270
+ idpconfigs: End-user identity provider configuration resources.
1271
+ imports: Import resources.
1272
+ integrations: Integration workspace resources.
1273
+ lookupcaches: Lookup cache resources.
1274
+ mcpoauthproviders: MCP OAuth provider resources.
1275
+ mcpservers: MCP server resources.
1276
+ revisions: Revision snapshot resources.
1277
+ roles: End-user role resources.
1278
+ scripts: Script resources.
1279
+ ssoclients: SSO client configuration resources.
1280
+ stacks: Stack resources.
1281
+ syncs: Sync resources.
1282
+ tools: Tool resources.
1283
+ description: Plural resource type.
1284
+ requestBody:
1285
+ required: true
1286
+ content:
1287
+ application/json:
1288
+ schema:
1289
+ $ref: '#/components/schemas/AuditDownloadRequest'
1290
+ examples:
1291
+ minimal:
1292
+ summary: Minimal — just resource IDs
1293
+ value:
1294
+ _resourceIds:
1295
+ - 60a2c4e6f321d800129a1a3c
1296
+ - 60a2c4e6f321d800129a1a4d
1297
+ filtered:
1298
+ summary: With time range and action filter
1299
+ value:
1300
+ _resourceIds:
1301
+ - 60a2c4e6f321d800129a1a3c
1302
+ from: '2025-01-01T00:00:00.000Z'
1303
+ to: '2025-12-31T23:59:59.999Z'
1304
+ action: update
1305
+ responses:
1306
+ '200':
1307
+ description: Signed URL response
1308
+ content:
1309
+ application/json:
1310
+ schema:
1311
+ $ref: '#/components/schemas/SignedUrlResponse'
1312
+ examples:
1313
+ default:
1314
+ value:
1315
+ signedURL: https://integrator-userdata-delete-30.s3.us-east-1.amazonaws.com/audit/624cb034630.../audit-export.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=900&...
1316
+ hasMore: false
1317
+ '400':
1318
+ $ref: '#/components/responses/400-bad-request'
1319
+ '401':
1320
+ $ref: '#/components/responses/401-unauthorized'
1321
+ '422':
1322
+ $ref: '#/components/responses/422-unprocessable-entity'
1323
+ components:
1324
+ securitySchemes:
1325
+ bearerAuth:
1326
+ type: http
1327
+ scheme: bearer
1328
+ schemas:
1329
+ FieldChange:
1330
+ type: object
1331
+ description: A single field-level change within an audit entry.
1332
+ properties:
1333
+ fieldPath:
1334
+ type: string
1335
+ description: Dot-path to the changed field (e.g., `settings.foo.bar`).
1336
+ examples:
1337
+ - http.auth.token.token
1338
+ oldValue:
1339
+ description: Previous value (may be any JSON type).
1340
+ newValue:
1341
+ description: New value (may be any JSON type).
1342
+ DeletedInfo:
1343
+ type: object
1344
+ description: Extra context recorded for delete events (when available).
1345
+ properties:
1346
+ name:
1347
+ type: string
1348
+ description: Name of the deleted resource (if available).
1349
+ examples:
1350
+ - My HTTP Connection
1351
+ _integrationId:
1352
+ type: string
1353
+ format: objectId
1354
+ x-celigo-refModel: integrations
1355
+ description: Integration id context (for flow/sync-related events).
1356
+ examples:
1357
+ - 60a2c4e6f321d800129a1a3c
1358
+ _abstractFlowId:
1359
+ type: string
1360
+ format: objectId
1361
+ x-celigo-refModel: flows
1362
+ description: Abstract flow id (for instance flow events).
1363
+ examples:
1364
+ - 6610a2c4e6f321d800129b2d
1365
+ _syncId:
1366
+ type: string
1367
+ format: objectId
1368
+ x-celigo-refModel: syncs
1369
+ description: Sync id context (for dataset events).
1370
+ examples:
1371
+ - 66b3c5d7e8f901a2b3c4d5e6
1372
+ AuditEntry:
1373
+ type: object
1374
+ required:
1375
+ - _id
1376
+ - event
1377
+ - resourceType
1378
+ - source
1379
+ - time
1380
+ - byUser
1381
+ - fieldChanges
1382
+ description: An audit log entry.
1383
+ properties:
1384
+ _id:
1385
+ type: string
1386
+ format: objectId
1387
+ readOnly: true
1388
+ description: Audit entry id.
1389
+ examples:
1390
+ - 69fe3b7833f18c171d7e91b9
1391
+ byUser:
1392
+ type: object
1393
+ readOnly: true
1394
+ description: The user who performed the action. Populated at read time from the current user record.
1395
+ properties:
1396
+ _id:
1397
+ type: string
1398
+ format: objectId
1399
+ x-celigo-refModel: users
1400
+ description: User id of the actor.
1401
+ examples:
1402
+ - 624cb0346309dc3a543733a2
1403
+ email:
1404
+ type: string
1405
+ description: Actor's current email address.
1406
+ examples:
1407
+ - jane.doe@example.com
1408
+ name:
1409
+ type: string
1410
+ description: Actor's current display name.
1411
+ examples:
1412
+ - Jane Doe
1413
+ resourceType:
1414
+ type: string
1415
+ readOnly: true
1416
+ description: Resource type that the audit entry applies to.
1417
+ enum:
1418
+ - accesstoken
1419
+ - agent
1420
+ - api
1421
+ - ashare
1422
+ - asynchelper
1423
+ - connection
1424
+ - dataset
1425
+ - ediprofile
1426
+ - environment
1427
+ - export
1428
+ - file
1429
+ - filedefinition
1430
+ - flow
1431
+ - folder
1432
+ - group
1433
+ - iclient
1434
+ - idpconfig
1435
+ - import
1436
+ - integration
1437
+ - lookupcache
1438
+ - mcpoauthprovider
1439
+ - mcpserver
1440
+ - notification
1441
+ - revision
1442
+ - role
1443
+ - script
1444
+ - ssoclient
1445
+ - stack
1446
+ - supportshare
1447
+ - sync
1448
+ - tool
1449
+ - user
1450
+ x-enumDescriptions:
1451
+ accesstoken: API access token resource.
1452
+ agent: On-premise agent resource.
1453
+ api: Custom API endpoint resource.
1454
+ ashare: Workspace user access record (account share) resource.
1455
+ asynchelper: Async helper resource used for long-running operations.
1456
+ connection: Connection resource for authenticating to external systems.
1457
+ dataset: Dataset resource for data storage.
1458
+ ediprofile: EDI profile resource for trading partner interchange configuration.
1459
+ environment: Environment variable resource.
1460
+ export: Export resource for reading data from a source system.
1461
+ file: Celigo Storage file resource.
1462
+ filedefinition: File definition resource for parsing structured files.
1463
+ flow: Flow resource for data integration pipelines.
1464
+ folder: Celigo Storage folder resource.
1465
+ group: End-user group resource.
1466
+ iclient: iClient shared credential resource.
1467
+ idpconfig: End-user identity provider configuration resource.
1468
+ import: Import resource for writing data to a destination system.
1469
+ integration: Integration workspace resource.
1470
+ lookupcache: Lookup cache resource for in-memory key-value stores.
1471
+ mcpoauthprovider: MCP OAuth provider resource.
1472
+ mcpserver: MCP server resource for AI agent tool hosting.
1473
+ notification: Notification subscription resource.
1474
+ revision: Revision snapshot resource for version control.
1475
+ role: End-user role resource.
1476
+ script: Script resource for custom JavaScript hooks.
1477
+ ssoclient: SSO client configuration resource.
1478
+ stack: Stack resource for on-premise or Lambda execution environments.
1479
+ supportshare: Support share access grant resource.
1480
+ sync: Sync resource.
1481
+ tool: Tool resource for reusable building blocks.
1482
+ user: User access record resource.
1483
+ _resourceId:
1484
+ type: string
1485
+ format: objectId
1486
+ readOnly: true
1487
+ description: Resource id the audit entry applies to.
1488
+ examples:
1489
+ - 69497ca1b40d3e24522a7f3c
1490
+ source:
1491
+ type: string
1492
+ readOnly: true
1493
+ description: Source of the change.
1494
+ enum:
1495
+ - ui
1496
+ - api
1497
+ - system
1498
+ - connector
1499
+ - script
1500
+ - stack
1501
+ - sso
1502
+ - cli
1503
+ - mcp
1504
+ - ora
1505
+ x-enumDescriptions:
1506
+ ui: Change made through the Celigo web UI.
1507
+ api: Change made via the REST API.
1508
+ system: Change made automatically by the platform.
1509
+ connector: Change made by an Integration App (connector) process.
1510
+ stack: Change made by extension code hosted on a stack.
1511
+ script: Change made by a custom script execution.
1512
+ sso: Change triggered by an SSO authentication event.
1513
+ cli: Change made via the Celigo CLI.
1514
+ mcp: Change made through the Celigo Platform MCP server.
1515
+ ora: Change made by the Ora AI assistant.
1516
+ support:
1517
+ type: boolean
1518
+ readOnly: true
1519
+ description: When true, the action was performed by support tooling/context.
1520
+ fieldChanges:
1521
+ type: array
1522
+ readOnly: true
1523
+ description: List of field-level changes (when applicable).
1524
+ items:
1525
+ $ref: '#/components/schemas/FieldChange'
1526
+ deletedInfo:
1527
+ $ref: '#/components/schemas/DeletedInfo'
1528
+ event:
1529
+ type: string
1530
+ readOnly: true
1531
+ description: Audit event type.
1532
+ enum:
1533
+ - create
1534
+ - update
1535
+ - delete
1536
+ - view
1537
+ - restore
1538
+ - purge
1539
+ - signin
1540
+ - signout
1541
+ - purgelogs
1542
+ x-enumDescriptions:
1543
+ create: A resource was created.
1544
+ update: A resource was modified.
1545
+ delete: A resource was deleted (moved to recycle bin).
1546
+ view: A resource was viewed or accessed.
1547
+ restore: A resource was restored from the recycle bin.
1548
+ purge: A resource was permanently purged from the recycle bin.
1549
+ signin: A user signed in to the account.
1550
+ signout: A user signed out of the account.
1551
+ purgelogs: Execution logs were purged for a resource.
1552
+ time:
1553
+ type: string
1554
+ format: date-time
1555
+ readOnly: true
1556
+ description: Timestamp when the action occurred.
1557
+ examples:
1558
+ - '2026-05-08T19:37:27.436Z'
1559
+ Error:
1560
+ type: object
1561
+ description: Standard error response envelope returned by integrator.io APIs.
1562
+ properties:
1563
+ errors:
1564
+ type: array
1565
+ description: List of errors that occurred while processing the request.
1566
+ items:
1567
+ type: object
1568
+ properties:
1569
+ code:
1570
+ oneOf:
1571
+ - type: string
1572
+ - type: integer
1573
+ description: |-
1574
+ Machine-readable error code. Usually a string like
1575
+ `invalid_ref`, `missing_required_field`, or `unauthorized`;
1576
+ may be an **integer** when the error mirrors an upstream HTTP
1577
+ status (e.g. `500`) — most commonly returned by connection-ping
1578
+ and adaptor-proxy responses.
1579
+ message:
1580
+ type: string
1581
+ description: Human-readable description of the error.
1582
+ field:
1583
+ type: string
1584
+ description: |-
1585
+ Optional pointer to the document field that caused the error.
1586
+ Used by structural validation errors (`missing_required_field`,
1587
+ `invalid_ref`) to indicate which field is at fault
1588
+ (e.g. `_id`, `type`, `http.baseURI`).
1589
+ source:
1590
+ type: string
1591
+ description: |-
1592
+ Optional origin layer for the error — e.g. `application` when
1593
+ the error came from the remote system the adaptor called,
1594
+ `connector` when the adaptor itself rejected the request.
1595
+ required:
1596
+ - message
1597
+ required:
1598
+ - errors
1599
+ AuditQueryFilters:
1600
+ type: object
1601
+ description: |-
1602
+ Multi-select audit filters for the POST query endpoints. Every filter is
1603
+ an array — send multiple values to match any of them. Pagination
1604
+ (`after`, `before`, `limit`, `sort_order`, `sort_by`) and time bounds
1605
+ (`from`, `to`) belong in the query string, not this body — including
1606
+ them here fails with 400 `invalid_request_body`.
1607
+ properties:
1608
+ resourceType:
1609
+ type: array
1610
+ description: Match entries for any of these resource types (singular form).
1611
+ items:
1612
+ type: string
1613
+ enum:
1614
+ - accesstoken
1615
+ - agent
1616
+ - api
1617
+ - ashare
1618
+ - asynchelper
1619
+ - connection
1620
+ - dataset
1621
+ - ediprofile
1622
+ - environment
1623
+ - export
1624
+ - file
1625
+ - filedefinition
1626
+ - flow
1627
+ - folder
1628
+ - group
1629
+ - iclient
1630
+ - idpconfig
1631
+ - import
1632
+ - integration
1633
+ - lookupcache
1634
+ - mcpoauthprovider
1635
+ - mcpserver
1636
+ - notification
1637
+ - revision
1638
+ - role
1639
+ - script
1640
+ - ssoclient
1641
+ - stack
1642
+ - supportshare
1643
+ - sync
1644
+ - tool
1645
+ - user
1646
+ x-enumDescriptions:
1647
+ accesstoken: API access token resource.
1648
+ agent: On-premise agent resource.
1649
+ api: Custom API endpoint resource.
1650
+ ashare: Workspace user access record (account share) resource.
1651
+ asynchelper: Async helper resource used for long-running operations.
1652
+ connection: Connection resource for authenticating to external systems.
1653
+ dataset: Dataset resource for data storage.
1654
+ ediprofile: EDI profile resource for trading partner interchange configuration.
1655
+ environment: Environment variable resource.
1656
+ export: Export resource for reading data from a source system.
1657
+ file: Celigo Storage file resource.
1658
+ filedefinition: File definition resource for parsing structured files.
1659
+ flow: Flow resource for data integration pipelines.
1660
+ folder: Celigo Storage folder resource.
1661
+ group: End-user group resource.
1662
+ iclient: iClient shared credential resource.
1663
+ idpconfig: End-user identity provider configuration resource.
1664
+ import: Import resource for writing data to a destination system.
1665
+ integration: Integration workspace resource.
1666
+ lookupcache: Lookup cache resource for in-memory key-value stores.
1667
+ mcpoauthprovider: MCP OAuth provider resource.
1668
+ mcpserver: MCP server resource for AI agent tool hosting.
1669
+ notification: Notification subscription resource.
1670
+ revision: Revision snapshot resource for version control.
1671
+ role: End-user role resource.
1672
+ script: Script resource for custom JavaScript hooks.
1673
+ ssoclient: SSO client configuration resource.
1674
+ stack: Stack resource for on-premise or Lambda execution environments.
1675
+ supportshare: Support share access grant resource.
1676
+ sync: Sync resource.
1677
+ tool: Tool resource for reusable building blocks.
1678
+ user: User access record resource.
1679
+ examples:
1680
+ - - connection
1681
+ - agent
1682
+ source:
1683
+ type: array
1684
+ description: Match entries produced by any of these sources.
1685
+ items:
1686
+ type: string
1687
+ enum:
1688
+ - ui
1689
+ - api
1690
+ - system
1691
+ - connector
1692
+ - script
1693
+ - stack
1694
+ - sso
1695
+ - cli
1696
+ - mcp
1697
+ - ora
1698
+ x-enumDescriptions:
1699
+ ui: Change made through the Celigo web UI.
1700
+ api: Change made via the REST API.
1701
+ system: Change made automatically by the platform.
1702
+ connector: Change made by an Integration App (connector) process.
1703
+ script: Change made by a custom script execution.
1704
+ stack: Change made by extension code hosted on a stack.
1705
+ sso: Change triggered by an SSO authentication event.
1706
+ cli: Change made via the Celigo CLI.
1707
+ mcp: Change made through the Celigo Platform MCP server.
1708
+ ora: Change made by the Ora AI assistant.
1709
+ examples:
1710
+ - - api
1711
+ - system
1712
+ action:
1713
+ type: array
1714
+ description: Match entries recording any of these actions.
1715
+ items:
1716
+ type: string
1717
+ enum:
1718
+ - create
1719
+ - update
1720
+ - delete
1721
+ - view
1722
+ - restore
1723
+ - purge
1724
+ - signin
1725
+ - signout
1726
+ - purgelogs
1727
+ x-enumDescriptions:
1728
+ create: A resource was created.
1729
+ update: A resource was modified.
1730
+ delete: A resource was deleted (moved to recycle bin).
1731
+ view: A resource was viewed or accessed.
1732
+ restore: A resource was restored from the recycle bin.
1733
+ purge: A resource was permanently purged from the recycle bin.
1734
+ signin: A user signed in to the account.
1735
+ signout: A user signed out of the account.
1736
+ purgelogs: Execution logs were purged for a resource.
1737
+ examples:
1738
+ - - create
1739
+ - update
1740
+ resourceName:
1741
+ type: array
1742
+ description: |-
1743
+ Restrict results to specific resources, each identified by its id and
1744
+ type. Entries missing either key, or naming a type without audit
1745
+ support, fail with 422.
1746
+ items:
1747
+ type: object
1748
+ required:
1749
+ - _resourceId
1750
+ - resourceType
1751
+ properties:
1752
+ _resourceId:
1753
+ type: string
1754
+ format: objectId
1755
+ description: Id of the resource to include.
1756
+ examples:
1757
+ - 60a2c4e6f321d800129a1a3c
1758
+ resourceType:
1759
+ type: string
1760
+ description: Singular resource type of `_resourceId`.
1761
+ examples:
1762
+ - connection
1763
+ SignedUrlResponse:
1764
+ type: object
1765
+ description: |-
1766
+ Response containing a signed URL for downloading an audit CSV export.
1767
+
1768
+ Each CSV is capped at roughly 20 000 rows. When `hasMore` is `true`,
1769
+ pass the timestamp of the last row as the `to` query parameter on the
1770
+ next request to fetch the next batch.
1771
+ properties:
1772
+ signedURL:
1773
+ type: string
1774
+ description: Signed URL to download the CSV. The link expires after 15 minutes.
1775
+ examples:
1776
+ - https://integrator-userdata-delete-30.s3.us-east-1.amazonaws.com/audit/624cb034630a1b2c3d4e5f60/audit-export.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=900&X-Amz-Credential=AKIAEXAMPLE123%2F20260613%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260613T120000Z&X-Amz-SignedHeaders=host&X-Amz-Signature=4f9b2c1e8a3d7f0b5c6e9a2d4f8b1c3e7a0d5f2b9c4e6a8d1f3b7c0e5a9d2f4b
1777
+ hasMore:
1778
+ type: boolean
1779
+ description: |-
1780
+ `true` when the result set exceeded the per-file row limit (~20 000 rows)
1781
+ and additional batches remain. To paginate, take the timestamp of the
1782
+ last CSV row and pass it as the `to` query parameter on your next request.
1783
+ AuditDownloadRequest:
1784
+ type: object
1785
+ description: Request body for `POST /v1/{resourceType}/audit/signedURL`.
1786
+ properties:
1787
+ _resourceIds:
1788
+ type: array
1789
+ description: List of resource ids to include in the audit export.
1790
+ items:
1791
+ type: string
1792
+ from:
1793
+ type: string
1794
+ format: date-time
1795
+ description: Start timestamp (ISO-8601).
1796
+ examples:
1797
+ - '2025-01-01T00:00:00.000Z'
1798
+ to:
1799
+ type: string
1800
+ format: date-time
1801
+ description: End timestamp (ISO-8601).
1802
+ examples:
1803
+ - '2025-12-31T23:59:59.999Z'
1804
+ action:
1805
+ type: string
1806
+ enum:
1807
+ - create
1808
+ - update
1809
+ - delete
1810
+ - view
1811
+ - restore
1812
+ - purge
1813
+ - signin
1814
+ - signout
1815
+ - purgelogs
1816
+ x-enumDescriptions:
1817
+ create: A resource was created.
1818
+ update: A resource was modified.
1819
+ delete: A resource was deleted (moved to recycle bin).
1820
+ view: A resource was viewed or accessed.
1821
+ restore: A resource was restored from the recycle bin.
1822
+ purge: A resource was permanently purged from the recycle bin.
1823
+ signin: A user signed in to the account.
1824
+ signout: A user signed out of the account.
1825
+ purgelogs: Execution logs were purged for a resource.
1826
+ description: Event/action filter.
1827
+ resourceType:
1828
+ type: string
1829
+ description: Resource type filter (singular form).
1830
+ enum:
1831
+ - accesstoken
1832
+ - agent
1833
+ - api
1834
+ - ashare
1835
+ - asynchelper
1836
+ - connection
1837
+ - dataset
1838
+ - ediprofile
1839
+ - environment
1840
+ - export
1841
+ - file
1842
+ - filedefinition
1843
+ - flow
1844
+ - folder
1845
+ - group
1846
+ - iclient
1847
+ - idpconfig
1848
+ - import
1849
+ - integration
1850
+ - lookupcache
1851
+ - mcpoauthprovider
1852
+ - mcpserver
1853
+ - notification
1854
+ - revision
1855
+ - role
1856
+ - script
1857
+ - ssoclient
1858
+ - stack
1859
+ - supportshare
1860
+ - sync
1861
+ - tool
1862
+ - user
1863
+ x-enumDescriptions:
1864
+ accesstoken: API access token resource.
1865
+ agent: On-premise agent resource.
1866
+ api: Custom API endpoint resource.
1867
+ ashare: Workspace user access record (account share) resource.
1868
+ asynchelper: Async helper resource used for long-running operations.
1869
+ connection: Connection resource for authenticating to external systems.
1870
+ dataset: Dataset resource for data storage.
1871
+ ediprofile: EDI profile resource for trading partner interchange configuration.
1872
+ environment: Environment variable resource.
1873
+ export: Export resource for reading data from a source system.
1874
+ file: Celigo Storage file resource.
1875
+ filedefinition: File definition resource for parsing structured files.
1876
+ flow: Flow resource for data integration pipelines.
1877
+ folder: Celigo Storage folder resource.
1878
+ group: End-user group resource.
1879
+ iclient: iClient shared credential resource.
1880
+ idpconfig: End-user identity provider configuration resource.
1881
+ import: Import resource for writing data to a destination system.
1882
+ integration: Integration workspace resource.
1883
+ lookupcache: Lookup cache resource for in-memory key-value stores.
1884
+ mcpoauthprovider: MCP OAuth provider resource.
1885
+ mcpserver: MCP server resource for AI agent tool hosting.
1886
+ notification: Notification subscription resource.
1887
+ revision: Revision snapshot resource for version control.
1888
+ role: End-user role resource.
1889
+ script: Script resource for custom JavaScript hooks.
1890
+ ssoclient: SSO client configuration resource.
1891
+ stack: Stack resource for on-premise or Lambda execution environments.
1892
+ supportshare: Support share access grant resource.
1893
+ sync: Sync resource.
1894
+ tool: Tool resource for reusable building blocks.
1895
+ user: User access record resource.
1896
+ source:
1897
+ type: string
1898
+ enum:
1899
+ - ui
1900
+ - api
1901
+ - system
1902
+ - connector
1903
+ - script
1904
+ - sso
1905
+ - cli
1906
+ - mcp
1907
+ - ora
1908
+ x-enumDescriptions:
1909
+ ui: Change made through the Celigo web UI.
1910
+ api: Change made via the REST API.
1911
+ system: Change made automatically by the platform.
1912
+ connector: Change made by an Integration App (connector) process.
1913
+ script: Change made by a custom script execution.
1914
+ sso: Change triggered by an SSO authentication event.
1915
+ cli: Change made via the Celigo CLI.
1916
+ mcp: Change made through the Celigo Platform MCP server.
1917
+ ora: Change made by the Ora AI assistant.
1918
+ description: Source filter.
1919
+ _byUserId:
1920
+ type: string
1921
+ x-celigo-refModel: users
1922
+ description: Filter by actor user id (or `support`).
1923
+ examples:
1924
+ - 624cb0346309dc3a543733a2
1925
+ required:
1926
+ - _resourceIds
1927
+ x-celigo-ai-guidance:
1928
+ - |-
1929
+ - Provide `_resourceIds` as a list of ids you want audit logs for.
1930
+ - You can optionally include filters like time range and event/action.
1931
+ responses:
1932
+ 400-bad-request:
1933
+ description: |
1934
+ Bad request. The server could not understand the request because of malformed syntax or invalid parameters.
1935
+ content:
1936
+ application/json:
1937
+ schema:
1938
+ $ref: '#/components/schemas/Error'
1939
+ examples:
1940
+ default:
1941
+ value:
1942
+ errors:
1943
+ - code: invalid_request
1944
+ message: The request body failed validation.
1945
+ 401-unauthorized:
1946
+ description: |-
1947
+ Unauthorized. The request lacks a valid bearer token, or the provided token
1948
+ failed to authenticate.
1949
+
1950
+ Note: the 401 response is produced by the auth middleware **before** the
1951
+ request reaches the endpoint handler, so it does **not** follow the
1952
+ standard `{errors: [...]}` envelope. Instead the body is a bare
1953
+ `{message: string}` object with no `code`, no `errors` array. Callers
1954
+ handling 401s should key off the HTTP status and the `message` string,
1955
+ not try to destructure an `errors[]`.
1956
+ content:
1957
+ application/json:
1958
+ schema:
1959
+ type: object
1960
+ properties:
1961
+ message:
1962
+ type: string
1963
+ description: |-
1964
+ Human-readable description of the auth failure. Known values:
1965
+ - `"Unauthorized"` — no `Authorization` header on the request.
1966
+ - `"Bearer Authentication Failed"` — header present but token
1967
+ is invalid, revoked, or expired.
1968
+ required:
1969
+ - message
1970
+ examples:
1971
+ missing_token:
1972
+ summary: No Authorization header sent
1973
+ value:
1974
+ message: Unauthorized
1975
+ invalid_token:
1976
+ summary: Bearer token invalid or revoked
1977
+ value:
1978
+ message: Bearer Authentication Failed
1979
+ 422-unprocessable-entity:
1980
+ description: |
1981
+ Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.
1982
+ content:
1983
+ application/json:
1984
+ schema:
1985
+ $ref: '#/components/schemas/Error'
1986
+ examples:
1987
+ default:
1988
+ value:
1989
+ errors:
1990
+ - code: unprocessable_entity
1991
+ message: The request could not be processed due to a semantic error.
1992
+ 404-not-found:
1993
+ description: |
1994
+ Not found. The requested resource does not exist or is not visible to the caller.
1995
+ content:
1996
+ application/json:
1997
+ schema:
1998
+ $ref: '#/components/schemas/Error'
1999
+ examples:
2000
+ default:
2001
+ value:
2002
+ errors:
2003
+ - code: not_found
2004
+ message: The requested resource was not found.
2005
+ x-enable-proxy: true
2006
+ x-internal: false