@itentialopensource/adapter-algosec_appviz 0.1.1 → 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 (41) hide show
  1. package/CALLS.md +378 -0
  2. package/CHANGELOG.md +16 -1
  3. package/CONTRIBUTING.md +1 -160
  4. package/ENHANCE.md +2 -2
  5. package/README.md +31 -22
  6. package/adapter.js +160 -330
  7. package/adapterBase.js +538 -873
  8. package/changelogs/changelog.md +9 -0
  9. package/metadata.json +49 -0
  10. package/package.json +23 -26
  11. package/pronghorn.json +474 -142
  12. package/propertiesSchema.json +453 -40
  13. package/refs?service=git-upload-pack +0 -0
  14. package/report/adapter-openapi.json +5974 -0
  15. package/report/adapter-openapi.yaml +4820 -0
  16. package/report/adapterInfo.json +10 -0
  17. package/report/updateReport1691508679246.json +120 -0
  18. package/report/updateReport1692203130600.json +120 -0
  19. package/report/updateReport1694467811112.json +120 -0
  20. package/report/updateReport1698422437946.json +120 -0
  21. package/sampleProperties.json +63 -2
  22. package/test/integration/adapterTestBasicGet.js +1 -1
  23. package/test/integration/adapterTestConnectivity.js +91 -42
  24. package/test/integration/adapterTestIntegration.js +130 -2
  25. package/test/unit/adapterBaseTestUnit.js +388 -313
  26. package/test/unit/adapterTestUnit.js +306 -109
  27. package/utils/adapterInfo.js +1 -1
  28. package/utils/addAuth.js +1 -1
  29. package/utils/artifactize.js +1 -1
  30. package/utils/checkMigrate.js +1 -1
  31. package/utils/entitiesToDB.js +1 -0
  32. package/utils/findPath.js +1 -1
  33. package/utils/methodDocumentor.js +71 -23
  34. package/utils/modify.js +13 -15
  35. package/utils/packModificationScript.js +1 -1
  36. package/utils/taskMover.js +309 -0
  37. package/utils/tbScript.js +3 -10
  38. package/utils/tbUtils.js +2 -3
  39. package/utils/testRunner.js +1 -1
  40. package/utils/troubleshootingAdapter.js +1 -3
  41. package/workflows/README.md +0 -3
@@ -0,0 +1,4820 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: AppViz REST Web Services
4
+ description: >-
5
+ Use the AlgoSec AppViz Web Services APIs to manage remote AppViz operations, such as retrieving or editing AppViz applications, flows, and objects.
6
+
7
+
8
+ Swagger is accessed from inside ASMS. Click Username > API Documentation.
9
+
10
+
11
+ Note: You must be logged in to ASMS to execute these APIs.
12
+ contact: {}
13
+ version: 'A32.20'
14
+ servers:
15
+ - url: https://{defaultHost}
16
+ variables:
17
+ defaultHost:
18
+ default: www.example.com/BusinessFlow/rest/v1
19
+ paths:
20
+ /applications/:
21
+ get:
22
+ tags:
23
+ - applications-api-controller
24
+ summary: getAllApplicationsUsingGET
25
+ description: The response is a subset of the results in pages
26
+ operationId: getAllApplicationsUsingGET
27
+ parameters:
28
+ - name: page_number
29
+ in: query
30
+ description: The page number
31
+ style: form
32
+ explode: true
33
+ schema:
34
+ type: integer
35
+ format: int32
36
+ default: 1
37
+ - name: page_size
38
+ in: query
39
+ description: The page size
40
+ style: form
41
+ explode: true
42
+ schema:
43
+ type: integer
44
+ format: int32
45
+ responses:
46
+ '200':
47
+ description: OK
48
+ headers: {}
49
+ content:
50
+ application/json;charset=utf-8:
51
+ schema:
52
+ type: array
53
+ items:
54
+ $ref: '#/components/schemas/APIApplication'
55
+ description: ''
56
+ '403':
57
+ description: Access Denied
58
+ headers: {}
59
+ content: {}
60
+ deprecated: false
61
+ /applications/activity_log:
62
+ get:
63
+ tags:
64
+ - applications-api-controller
65
+ summary: getAllApplicationsActivitiesUsingGET
66
+ description: Retrieve a list of activity log entries for all applications
67
+ operationId: getAllApplicationsActivitiesUsingGET
68
+ parameters: []
69
+ responses:
70
+ '200':
71
+ description: OK
72
+ headers: {}
73
+ content:
74
+ application/json;charset=utf-8:
75
+ schema:
76
+ type: array
77
+ items:
78
+ $ref: '#/components/schemas/APIApplicationActivityLog'
79
+ description: ''
80
+ '403':
81
+ description: Access Denied
82
+ headers: {}
83
+ content: {}
84
+ deprecated: false
85
+ /applications/id/{id}:
86
+ get:
87
+ tags:
88
+ - applications-api-controller
89
+ summary: getApplicationByAppIdUsingGET
90
+ description: Retrieve an application by app_id
91
+ operationId: getApplicationByAppIdUsingGET
92
+ parameters:
93
+ - name: id
94
+ in: path
95
+ description: Application app_id (the id of the first application revision)
96
+ required: true
97
+ style: simple
98
+ schema:
99
+ type: integer
100
+ format: int32
101
+ responses:
102
+ '200':
103
+ description: OK
104
+ headers: {}
105
+ content:
106
+ application/json;charset=utf-8:
107
+ schema:
108
+ allOf:
109
+ - $ref: '#/components/schemas/APIApplication'
110
+ - description: Application data
111
+ '403':
112
+ description: The user is missing required permissions
113
+ headers: {}
114
+ content: {}
115
+ '404':
116
+ description: Application not found or the user is missing required permissions
117
+ headers: {}
118
+ content: {}
119
+ deprecated: false
120
+ /applications/id/{id}/revisions:
121
+ get:
122
+ tags:
123
+ - applications-api-controller
124
+ summary: getApplicationRevisionsByAppIdUsingGET
125
+ description: Retrieve a list of all revisions for an application by app_id
126
+ operationId: getApplicationRevisionsByAppIdUsingGET
127
+ parameters:
128
+ - name: id
129
+ in: path
130
+ description: Application app_id (the id of the first application revision)
131
+ required: true
132
+ style: simple
133
+ schema:
134
+ type: integer
135
+ format: int32
136
+ responses:
137
+ '200':
138
+ description: OK
139
+ headers: {}
140
+ content:
141
+ application/json;charset=utf-8:
142
+ schema:
143
+ type: array
144
+ items:
145
+ $ref: '#/components/schemas/RestBaseApplicationRevision'
146
+ description: ''
147
+ '403':
148
+ description: The user is missing required permissions
149
+ headers: {}
150
+ content: {}
151
+ '404':
152
+ description: Application not found
153
+ headers: {}
154
+ content: {}
155
+ deprecated: false
156
+ /applications/name/**:
157
+ get:
158
+ tags:
159
+ - applications-api-controller
160
+ summary: getApplicationByNameUsingGET
161
+ description: This API cannot be tested in Swagger
162
+ operationId: getApplicationByNameUsingGET
163
+ parameters: []
164
+ responses:
165
+ '200':
166
+ description: OK
167
+ headers: {}
168
+ content:
169
+ application/json;charset=utf-8:
170
+ schema:
171
+ allOf:
172
+ - $ref: '#/components/schemas/APIApplication'
173
+ - description: Application data
174
+ '403':
175
+ description: Access Denied
176
+ headers: {}
177
+ content: {}
178
+ deprecated: false
179
+ /applications/new:
180
+ post:
181
+ tags:
182
+ - applications-api-controller
183
+ summary: newApplicationUsingPOST
184
+ description: Create a new application
185
+ operationId: newApplicationUsingPOST
186
+ parameters: []
187
+ requestBody:
188
+ description: Data for new application
189
+ content:
190
+ application/json:
191
+ schema:
192
+ allOf:
193
+ - $ref: '#/components/schemas/ApplicationsNewRequest'
194
+ - description: Data for new application
195
+ required: true
196
+ responses:
197
+ '200':
198
+ description: OK
199
+ headers: {}
200
+ content:
201
+ application/json;charset=utf-8:
202
+ schema:
203
+ allOf:
204
+ - $ref: '#/components/schemas/APIApplication'
205
+ - description: Application data
206
+ '400':
207
+ description: Illegal request parameters
208
+ headers: {}
209
+ content: {}
210
+ '403':
211
+ description: The user is missing required permissions
212
+ headers: {}
213
+ content: {}
214
+ deprecated: false
215
+ /applications/pci:
216
+ get:
217
+ tags:
218
+ - applications-api-controller
219
+ summary: getPciApplicationsVulnerabilitiesUsingGET
220
+ description: Retrieve a list of vulnerabilities for all applications in PCI zone, filtered by devices
221
+ operationId: getPciApplicationsVulnerabilitiesUsingGET
222
+ parameters:
223
+ - name: devices
224
+ in: query
225
+ description: An array of device names to query
226
+ required: true
227
+ style: form
228
+ explode: true
229
+ schema:
230
+ type: array
231
+ items:
232
+ type: string
233
+ responses:
234
+ '200':
235
+ description: OK
236
+ headers: {}
237
+ content:
238
+ application/json;charset=utf-8:
239
+ schema:
240
+ type: array
241
+ items:
242
+ $ref: '#/components/schemas/PciApplicationVulnerabilityResponse'
243
+ description: ''
244
+ '403':
245
+ description: Access Denied
246
+ headers: {}
247
+ content: {}
248
+ '500':
249
+ description: Failed to get vulnerabilities for device
250
+ headers: {}
251
+ content: {}
252
+ deprecated: false
253
+ /applications/{id}:
254
+ get:
255
+ tags:
256
+ - applications-api-controller
257
+ summary: getApplicationByIdUsingGET
258
+ description: Retrieve an application by ID
259
+ operationId: getApplicationByIdUsingGET
260
+ parameters:
261
+ - name: id
262
+ in: path
263
+ description: Application revision ID
264
+ required: true
265
+ style: simple
266
+ schema:
267
+ type: integer
268
+ format: int32
269
+ responses:
270
+ '200':
271
+ description: OK
272
+ headers: {}
273
+ content:
274
+ application/json;charset=utf-8:
275
+ schema:
276
+ allOf:
277
+ - $ref: '#/components/schemas/APIApplication'
278
+ - description: Application data
279
+ '403':
280
+ description: The user is missing required permissions
281
+ headers: {}
282
+ content: {}
283
+ '404':
284
+ description: Application not found
285
+ headers: {}
286
+ content: {}
287
+ deprecated: false
288
+ /applications/{id}/activity_log:
289
+ get:
290
+ tags:
291
+ - applications-api-controller
292
+ summary: getActivitiesForApplicationUsingGET
293
+ description: Retrieve a list of activity log entries for an application
294
+ operationId: getActivitiesForApplicationUsingGET
295
+ parameters:
296
+ - name: id
297
+ in: path
298
+ description: Application revision ID
299
+ required: true
300
+ style: simple
301
+ schema:
302
+ type: integer
303
+ format: int32
304
+ responses:
305
+ '200':
306
+ description: OK
307
+ headers: {}
308
+ content:
309
+ application/json;charset=utf-8:
310
+ schema:
311
+ type: array
312
+ items:
313
+ $ref: '#/components/schemas/APIApplicationActivityLog'
314
+ description: ''
315
+ '403':
316
+ description: The user is missing required permissions
317
+ headers: {}
318
+ content: {}
319
+ '404':
320
+ description: Application not found
321
+ headers: {}
322
+ content: {}
323
+ deprecated: false
324
+ /applications/{id}/apply:
325
+ post:
326
+ tags:
327
+ - applications-api-controller
328
+ summary: applyDraftUsingPOST
329
+ description: Apply an application draft for opening a change request
330
+ operationId: applyDraftUsingPOST
331
+ parameters:
332
+ - name: id
333
+ in: path
334
+ description: Application revision ID
335
+ required: true
336
+ style: simple
337
+ schema:
338
+ type: integer
339
+ format: int32
340
+ - name: summary
341
+ in: query
342
+ description: Change request subject
343
+ style: form
344
+ explode: true
345
+ schema:
346
+ type: string
347
+ requestBody:
348
+ description: Flow IDs to include in change request
349
+ content:
350
+ application/json:
351
+ schema:
352
+ allOf:
353
+ - $ref: '#/components/schemas/ApplicationsApplyRequest'
354
+ - description: Flow IDs to include in change request
355
+ required: false
356
+ responses:
357
+ '200':
358
+ description: OK
359
+ headers: {}
360
+ content:
361
+ application/json;charset=utf-8:
362
+ schema:
363
+ allOf:
364
+ - $ref: '#/components/schemas/RestChangeApplicationResponse'
365
+ - description: Application data after change
366
+ '400':
367
+ description: Illegal request parameters
368
+ headers: {}
369
+ content: {}
370
+ '403':
371
+ description: The user is missing required permissions
372
+ headers: {}
373
+ content: {}
374
+ '404':
375
+ description: Application not found
376
+ headers: {}
377
+ content: {}
378
+ '500':
379
+ description: Failed to apply the draft revision
380
+ headers: {}
381
+ content: {}
382
+ deprecated: false
383
+ /applications/{id}/authorized_users_and_roles:
384
+ get:
385
+ tags:
386
+ - applications-api-controller
387
+ summary: getApplicationUsersAndRolesUsingGET
388
+ description: Retrieve all users and roles authorized to view or edit an application
389
+ operationId: getApplicationUsersAndRolesUsingGET
390
+ parameters:
391
+ - name: id
392
+ in: path
393
+ description: Application app_id (the id of the first application revision)
394
+ required: true
395
+ style: simple
396
+ schema:
397
+ type: integer
398
+ format: int32
399
+ responses:
400
+ '200':
401
+ description: OK
402
+ headers: {}
403
+ content:
404
+ application/json;charset=utf-8:
405
+ schema:
406
+ allOf:
407
+ - $ref: '#/components/schemas/APIApplicationPermittedEntities'
408
+ - description: Application users and roles permissions
409
+ '403':
410
+ description: The user is missing the Admin permissions
411
+ headers: {}
412
+ content: {}
413
+ '404':
414
+ description: Application not found or the user is missing required permissions
415
+ headers: {}
416
+ content: {}
417
+ deprecated: false
418
+ /applications/{id}/change_requests:
419
+ get:
420
+ tags:
421
+ - applications-api-controller
422
+ summary: getApplicationChangeRequestsUsingGET
423
+ description: Retrieve a list of FireFlow change requests for an application
424
+ operationId: getApplicationChangeRequestsUsingGET
425
+ parameters:
426
+ - name: id
427
+ in: path
428
+ description: Application revision ID
429
+ required: true
430
+ style: simple
431
+ schema:
432
+ type: integer
433
+ format: int32
434
+ responses:
435
+ '200':
436
+ description: OK
437
+ headers: {}
438
+ content:
439
+ application/json;charset=utf-8:
440
+ schema:
441
+ type: array
442
+ items:
443
+ $ref: '#/components/schemas/RestChangeRequest'
444
+ description: ''
445
+ '403':
446
+ description: The user is missing required permissions
447
+ headers: {}
448
+ content: {}
449
+ '404':
450
+ description: Application not found
451
+ headers: {}
452
+ content: {}
453
+ deprecated: false
454
+ /applications/{id}/check_connectivity:
455
+ post:
456
+ tags:
457
+ - applications-api-controller
458
+ summary: runCheckConnectivityUsingPOST
459
+ description: Run a connectivity check on an application
460
+ operationId: runCheckConnectivityUsingPOST
461
+ parameters:
462
+ - name: id
463
+ in: path
464
+ description: Application revision ID
465
+ required: true
466
+ style: simple
467
+ schema:
468
+ type: integer
469
+ format: int32
470
+ - name: Content-Type
471
+ in: header
472
+ description: ''
473
+ required: true
474
+ style: simple
475
+ schema:
476
+ $ref: '#/components/schemas/Content-Type'
477
+ responses:
478
+ '200':
479
+ description: OK
480
+ headers: {}
481
+ content:
482
+ application/json;charset=utf-8:
483
+ schema:
484
+ allOf:
485
+ - $ref: '#/components/schemas/RestApplicationConnectivity'
486
+ - description: Connectivity status for application flows
487
+ '403':
488
+ description: The user is missing the Refresh Connectivity permission
489
+ headers: {}
490
+ content: {}
491
+ '404':
492
+ description: Application not found
493
+ headers: {}
494
+ content: {}
495
+ deprecated: false
496
+ /applications/{id}/contacts:
497
+ get:
498
+ tags:
499
+ - applications-api-controller
500
+ summary: getApplicationContactsUsingGET
501
+ description: Retrieve a list of contacts for an application
502
+ operationId: getApplicationContactsUsingGET
503
+ parameters:
504
+ - name: id
505
+ in: path
506
+ description: Application revision ID
507
+ required: true
508
+ style: simple
509
+ schema:
510
+ type: integer
511
+ format: int32
512
+ responses:
513
+ '200':
514
+ description: OK
515
+ headers: {}
516
+ content:
517
+ application/json;charset=utf-8:
518
+ schema:
519
+ type: array
520
+ items:
521
+ $ref: '#/components/schemas/RestApplicationPersonRole'
522
+ description: ''
523
+ '403':
524
+ description: The user is missing required permissions
525
+ headers: {}
526
+ content: {}
527
+ '404':
528
+ description: Application not found
529
+ headers: {}
530
+ content: {}
531
+ deprecated: false
532
+ post:
533
+ tags:
534
+ - applications-api-controller
535
+ summary: editApplicationContactsUsingPOST
536
+ description: Edit contacts for an application
537
+ operationId: editApplicationContactsUsingPOST
538
+ parameters:
539
+ - name: id
540
+ in: path
541
+ description: Application revision ID
542
+ required: true
543
+ style: simple
544
+ schema:
545
+ type: integer
546
+ format: int32
547
+ requestBody:
548
+ description: Application contacts to add and remove
549
+ content:
550
+ application/json:
551
+ schema:
552
+ allOf:
553
+ - $ref: '#/components/schemas/ApplicationsContactsRequest'
554
+ - description: Application contacts to add and remove
555
+ required: true
556
+ responses:
557
+ '200':
558
+ description: OK
559
+ headers: {}
560
+ content:
561
+ application/json;charset=utf-8:
562
+ schema:
563
+ allOf:
564
+ - $ref: '#/components/schemas/APIEditApplicationContactsResponse'
565
+ - description: Contacts assigned to an application
566
+ '400':
567
+ description: Illegal request parameters
568
+ headers: {}
569
+ content: {}
570
+ '403':
571
+ description: The user is missing required permissions
572
+ headers: {}
573
+ content: {}
574
+ '404':
575
+ description: Application not found
576
+ headers: {}
577
+ content: {}
578
+ deprecated: false
579
+ delete:
580
+ tags:
581
+ - applications-api-controller
582
+ summary: clearAllApplicationContactsUsingDELETE
583
+ description: Remove all contacts for an application
584
+ operationId: clearAllApplicationContactsUsingDELETE
585
+ parameters:
586
+ - name: id
587
+ in: path
588
+ description: Application revision ID
589
+ required: true
590
+ style: simple
591
+ schema:
592
+ type: integer
593
+ format: int32
594
+ responses:
595
+ '200':
596
+ description: OK
597
+ headers: {}
598
+ content:
599
+ application/json;charset=utf-8:
600
+ schema:
601
+ allOf:
602
+ - $ref: '#/components/schemas/APIEditApplicationContactsResponse'
603
+ - description: Contacts assigned to an application
604
+ '400':
605
+ description: Illegal request parameters
606
+ headers: {}
607
+ content: {}
608
+ '403':
609
+ description: The user is missing required permissions
610
+ headers: {}
611
+ content: {}
612
+ '404':
613
+ description: Application not found
614
+ headers: {}
615
+ content: {}
616
+ deprecated: false
617
+ /applications/{id}/custom_fields:
618
+ post:
619
+ tags:
620
+ - applications-api-controller
621
+ summary: editCustomFieldsUsingPOST
622
+ description: Edit custom fields for an application
623
+ operationId: editCustomFieldsUsingPOST
624
+ parameters:
625
+ - name: id
626
+ in: path
627
+ description: Application revision ID
628
+ required: true
629
+ style: simple
630
+ schema:
631
+ type: integer
632
+ format: int32
633
+ requestBody:
634
+ description: Data to set for application custom fields
635
+ content:
636
+ application/json:
637
+ schema:
638
+ allOf:
639
+ - $ref: '#/components/schemas/ApplicationsCustomFieldsRequest'
640
+ - description: Data to set for application custom fields
641
+ required: true
642
+ responses:
643
+ '200':
644
+ description: OK
645
+ headers: {}
646
+ content:
647
+ application/json;charset=utf-8:
648
+ schema:
649
+ allOf:
650
+ - $ref: '#/components/schemas/APIEditApplicationCustomFieldResponse'
651
+ - description: List of custom fields values in an application
652
+ '400':
653
+ description: Illegal request parameters
654
+ headers: {}
655
+ content: {}
656
+ '403':
657
+ description: The user is missing required permissions
658
+ headers: {}
659
+ content: {}
660
+ '404':
661
+ description: Application not found
662
+ headers: {}
663
+ content: {}
664
+ deprecated: false
665
+ delete:
666
+ tags:
667
+ - applications-api-controller
668
+ summary: clearAllApplicationCustomFieldsUsingDELETE
669
+ description: Remove all custom fields for an application; system fields are excluded
670
+ operationId: clearAllApplicationCustomFieldsUsingDELETE
671
+ parameters:
672
+ - name: id
673
+ in: path
674
+ description: Application revision ID
675
+ required: true
676
+ style: simple
677
+ schema:
678
+ type: integer
679
+ format: int32
680
+ responses:
681
+ '200':
682
+ description: OK
683
+ headers: {}
684
+ content:
685
+ application/json;charset=utf-8:
686
+ schema:
687
+ $ref: '#/components/schemas/ResponseEntity'
688
+ '400':
689
+ description: Illegal request parameters
690
+ headers: {}
691
+ content: {}
692
+ '403':
693
+ description: The user is missing required permissions
694
+ headers: {}
695
+ content: {}
696
+ '404':
697
+ description: Application not found
698
+ headers: {}
699
+ content: {}
700
+ deprecated: false
701
+ /applications/{id}/decommission:
702
+ post:
703
+ tags:
704
+ - applications-api-controller
705
+ summary: decomissionApplicationUsingPOST
706
+ description: Decommission an application and issue a change request
707
+ operationId: decomissionApplicationUsingPOST
708
+ parameters:
709
+ - name: id
710
+ in: path
711
+ description: Application revision ID
712
+ required: true
713
+ style: simple
714
+ schema:
715
+ type: integer
716
+ format: int32
717
+ - name: summary
718
+ in: query
719
+ description: Change request subject
720
+ style: form
721
+ explode: true
722
+ schema:
723
+ type: string
724
+ - name: Content-Type
725
+ in: header
726
+ description: ''
727
+ required: true
728
+ style: simple
729
+ schema:
730
+ $ref: '#/components/schemas/Content-Type'
731
+ responses:
732
+ '200':
733
+ description: OK
734
+ headers: {}
735
+ content:
736
+ application/json;charset=utf-8:
737
+ schema:
738
+ allOf:
739
+ - $ref: '#/components/schemas/RestChangeApplicationResponse'
740
+ - description: Application data after change
741
+ '403':
742
+ description: The user is missing required permissions
743
+ headers: {}
744
+ content: {}
745
+ '404':
746
+ description: Application not found
747
+ headers: {}
748
+ content: {}
749
+ '500':
750
+ description: Application decommission failed
751
+ headers: {}
752
+ content: {}
753
+ deprecated: false
754
+ /applications/{id}/discard:
755
+ post:
756
+ tags:
757
+ - applications-api-controller
758
+ summary: discardRevisionUsingPOST
759
+ description: Discard the draft revision for an application
760
+ operationId: discardRevisionUsingPOST
761
+ parameters:
762
+ - name: id
763
+ in: path
764
+ description: Application revision ID
765
+ required: true
766
+ style: simple
767
+ schema:
768
+ type: integer
769
+ format: int32
770
+ - name: Content-Type
771
+ in: header
772
+ description: ''
773
+ required: true
774
+ style: simple
775
+ schema:
776
+ $ref: '#/components/schemas/Content-Type'
777
+ responses:
778
+ '200':
779
+ description: OK
780
+ headers: {}
781
+ content:
782
+ application/json;charset=utf-8:
783
+ schema:
784
+ $ref: '#/components/schemas/RestStatus'
785
+ '403':
786
+ description: The user is missing required permissions
787
+ headers: {}
788
+ content: {}
789
+ '404':
790
+ description: Application not found
791
+ headers: {}
792
+ content: {}
793
+ '500':
794
+ description: Discard application draft failed
795
+ headers: {}
796
+ content: {}
797
+ deprecated: false
798
+ /applications/{id}/labels:
799
+ get:
800
+ tags:
801
+ - applications-api-controller
802
+ summary: getApplicationLabelsUsingGET_1
803
+ description: Retrieve a list of tags for an application
804
+ operationId: getApplicationLabelsUsingGET_1
805
+ parameters:
806
+ - name: id
807
+ in: path
808
+ description: Application revision ID
809
+ required: true
810
+ style: simple
811
+ schema:
812
+ type: integer
813
+ format: int32
814
+ responses:
815
+ '200':
816
+ description: OK
817
+ headers: {}
818
+ content:
819
+ application/json;charset=utf-8:
820
+ schema:
821
+ type: array
822
+ items:
823
+ $ref: '#/components/schemas/APILabel'
824
+ description: ''
825
+ '403':
826
+ description: The user is missing required permissions
827
+ headers: {}
828
+ content: {}
829
+ '404':
830
+ description: Application not found
831
+ headers: {}
832
+ content: {}
833
+ deprecated: false
834
+ post:
835
+ tags:
836
+ - applications-api-controller
837
+ summary: editApplicationLabelsUsingPOST
838
+ description: Edit the tags for an application
839
+ operationId: editApplicationLabelsUsingPOST
840
+ parameters:
841
+ - name: id
842
+ in: path
843
+ description: Application revision ID
844
+ required: true
845
+ style: simple
846
+ schema:
847
+ type: integer
848
+ format: int32
849
+ requestBody:
850
+ description: Data to set for application tags
851
+ content:
852
+ application/json:
853
+ schema:
854
+ allOf:
855
+ - $ref: '#/components/schemas/ApplicationsLabelsRequest'
856
+ - description: Data to set for application tags
857
+ required: true
858
+ responses:
859
+ '200':
860
+ description: OK
861
+ headers: {}
862
+ content:
863
+ application/json;charset=utf-8:
864
+ schema:
865
+ allOf:
866
+ - $ref: '#/components/schemas/APIEditApplicationLabelsResponse'
867
+ - description: List of tags in an application
868
+ '400':
869
+ description: Illegal request parameters
870
+ headers: {}
871
+ content: {}
872
+ '403':
873
+ description: The user is missing required permissions
874
+ headers: {}
875
+ content: {}
876
+ '404':
877
+ description: Application not found
878
+ headers: {}
879
+ content: {}
880
+ deprecated: false
881
+ delete:
882
+ tags:
883
+ - applications-api-controller
884
+ summary: removeAllApplicationLabelsUsingDELETE
885
+ description: Remove all user-defined tags for an application; system tags are excluded
886
+ operationId: removeAllApplicationLabelsUsingDELETE
887
+ parameters:
888
+ - name: id
889
+ in: path
890
+ description: Application revision ID
891
+ required: true
892
+ style: simple
893
+ schema:
894
+ type: integer
895
+ format: int32
896
+ responses:
897
+ '200':
898
+ description: OK
899
+ headers: {}
900
+ content:
901
+ application/json;charset=utf-8:
902
+ schema:
903
+ $ref: '#/components/schemas/ResponseEntity'
904
+ '400':
905
+ description: Illegal request parameters
906
+ headers: {}
907
+ content: {}
908
+ '403':
909
+ description: The user is missing required permissions
910
+ headers: {}
911
+ content: {}
912
+ '404':
913
+ description: Application not found
914
+ headers: {}
915
+ content: {}
916
+ deprecated: false
917
+ /applications/{id}/labels/{type}:
918
+ get:
919
+ tags:
920
+ - applications-api-controller
921
+ summary: getApplicationLabelsUsingGET
922
+ description: Retrieve a list of tags for an application by type
923
+ operationId: getApplicationLabelsUsingGET
924
+ parameters:
925
+ - name: id
926
+ in: path
927
+ description: Application revision ID
928
+ required: true
929
+ style: simple
930
+ schema:
931
+ type: integer
932
+ format: int32
933
+ - name: type
934
+ in: path
935
+ description: Tag type
936
+ required: true
937
+ style: simple
938
+ schema:
939
+ allOf:
940
+ - $ref: '#/components/schemas/type81'
941
+ - description: Tag type
942
+ responses:
943
+ '200':
944
+ description: OK
945
+ headers: {}
946
+ content:
947
+ application/json;charset=utf-8:
948
+ schema:
949
+ type: array
950
+ items:
951
+ $ref: '#/components/schemas/APILabel'
952
+ description: ''
953
+ '403':
954
+ description: The user is missing required permissions
955
+ headers: {}
956
+ content: {}
957
+ '404':
958
+ description: Application not found
959
+ headers: {}
960
+ content: {}
961
+ deprecated: false
962
+ /applications/{id}/resolve:
963
+ post:
964
+ tags:
965
+ - applications-api-controller
966
+ summary: resolveApplicationUsingPOST
967
+ description: Issue a change request for blocked connectivity
968
+ operationId: resolveApplicationUsingPOST
969
+ parameters:
970
+ - name: id
971
+ in: path
972
+ description: Application revision ID
973
+ required: true
974
+ style: simple
975
+ schema:
976
+ type: integer
977
+ format: int32
978
+ - name: summary
979
+ in: query
980
+ description: Change request subject
981
+ style: form
982
+ explode: true
983
+ schema:
984
+ type: string
985
+ - name: Content-Type
986
+ in: header
987
+ description: ''
988
+ required: true
989
+ style: simple
990
+ schema:
991
+ $ref: '#/components/schemas/Content-Type'
992
+ responses:
993
+ '200':
994
+ description: OK
995
+ headers: {}
996
+ content:
997
+ application/json;charset=utf-8:
998
+ schema:
999
+ allOf:
1000
+ - $ref: '#/components/schemas/RestChangeApplicationResponse'
1001
+ - description: Application data after change
1002
+ '403':
1003
+ description: The user is missing required permissions
1004
+ headers: {}
1005
+ content: {}
1006
+ '404':
1007
+ description: Application not found
1008
+ headers: {}
1009
+ content: {}
1010
+ '500':
1011
+ description: Resolve application failed
1012
+ headers: {}
1013
+ content: {}
1014
+ deprecated: false
1015
+ /applications/{id}/revisions:
1016
+ get:
1017
+ tags:
1018
+ - applications-api-controller
1019
+ summary: getApplicationRevisionsUsingGET
1020
+ description: Retrieve a list of all revisions for an application
1021
+ operationId: getApplicationRevisionsUsingGET
1022
+ parameters:
1023
+ - name: id
1024
+ in: path
1025
+ description: Application revision ID
1026
+ required: true
1027
+ style: simple
1028
+ schema:
1029
+ type: integer
1030
+ format: int32
1031
+ responses:
1032
+ '200':
1033
+ description: OK
1034
+ headers: {}
1035
+ content:
1036
+ application/json;charset=utf-8:
1037
+ schema:
1038
+ type: array
1039
+ items:
1040
+ $ref: '#/components/schemas/RestBaseApplicationRevision'
1041
+ description: ''
1042
+ '403':
1043
+ description: The user is missing required permissions
1044
+ headers: {}
1045
+ content: {}
1046
+ '404':
1047
+ description: Application not found
1048
+ headers: {}
1049
+ content: {}
1050
+ deprecated: false
1051
+ /applications/{id}/risks:
1052
+ get:
1053
+ tags:
1054
+ - applications-api-controller
1055
+ summary: getApplicationRisksUsingGET
1056
+ description: Retrieve a list of risks for an application
1057
+ operationId: getApplicationRisksUsingGET
1058
+ parameters:
1059
+ - name: id
1060
+ in: path
1061
+ description: Application revision ID
1062
+ required: true
1063
+ style: simple
1064
+ schema:
1065
+ type: integer
1066
+ format: int32
1067
+ responses:
1068
+ '200':
1069
+ description: OK
1070
+ headers: {}
1071
+ content:
1072
+ application/json;charset=utf-8:
1073
+ schema:
1074
+ type: array
1075
+ items:
1076
+ $ref: '#/components/schemas/RestRisk'
1077
+ description: ''
1078
+ '403':
1079
+ description: The user is missing required permissions
1080
+ headers: {}
1081
+ content: {}
1082
+ '404':
1083
+ description: Application not found
1084
+ headers: {}
1085
+ content: {}
1086
+ deprecated: false
1087
+ /applications/{id}/vulnerabilities:
1088
+ get:
1089
+ tags:
1090
+ - applications-api-controller
1091
+ summary: getApplicationVulnerabilitiesUsingGET
1092
+ description: Retrieve a collection of vulnerabilities for an application
1093
+ operationId: getApplicationVulnerabilitiesUsingGET
1094
+ parameters:
1095
+ - name: id
1096
+ in: path
1097
+ description: Application revision ID
1098
+ required: true
1099
+ style: simple
1100
+ schema:
1101
+ type: integer
1102
+ format: int32
1103
+ responses:
1104
+ '200':
1105
+ description: OK
1106
+ headers: {}
1107
+ content:
1108
+ application/json;charset=utf-8:
1109
+ schema:
1110
+ allOf:
1111
+ - $ref: '#/components/schemas/RestApplicationVulnerability'
1112
+ - description: Application vulnerability information
1113
+ '403':
1114
+ description: The user is missing required permissions
1115
+ headers: {}
1116
+ content: {}
1117
+ '404':
1118
+ description: Application not found
1119
+ headers: {}
1120
+ content: {}
1121
+ deprecated: false
1122
+ /applications/{id}/flows:
1123
+ get:
1124
+ tags:
1125
+ - flows-api-controller
1126
+ summary: getApplicationFlowsUsingGET
1127
+ description: Retrieve a list of application flows by application ID
1128
+ operationId: getApplicationFlowsUsingGET
1129
+ parameters:
1130
+ - name: id
1131
+ in: path
1132
+ description: Application revision ID
1133
+ required: true
1134
+ style: simple
1135
+ schema:
1136
+ type: integer
1137
+ format: int32
1138
+ - name: includeVulnerabilityInformation
1139
+ in: query
1140
+ description: Include vulnerability information. set to false to improve performance
1141
+ style: form
1142
+ explode: true
1143
+ schema:
1144
+ type: boolean
1145
+ default: true
1146
+ responses:
1147
+ '200':
1148
+ description: OK
1149
+ headers: {}
1150
+ content:
1151
+ application/json;charset=utf-8:
1152
+ schema:
1153
+ type: array
1154
+ items:
1155
+ $ref: '#/components/schemas/APIFlow'
1156
+ description: ''
1157
+ '403':
1158
+ description: The user is missing required permissions
1159
+ headers: {}
1160
+ content: {}
1161
+ '404':
1162
+ description: Application not found
1163
+ headers: {}
1164
+ content: {}
1165
+ deprecated: false
1166
+ post:
1167
+ tags:
1168
+ - flows-api-controller
1169
+ summary: editApplicationFlowUsingPOST
1170
+ description: Edit the flows for an application
1171
+ operationId: editApplicationFlowUsingPOST
1172
+ parameters:
1173
+ - name: id
1174
+ in: path
1175
+ description: Application revision ID
1176
+ required: true
1177
+ style: simple
1178
+ schema:
1179
+ type: integer
1180
+ format: int32
1181
+ requestBody:
1182
+ description: List of flow changes
1183
+ content:
1184
+ application/json:
1185
+ schema:
1186
+ type: array
1187
+ items:
1188
+ $ref: '#/components/schemas/APIEditFlowRequest'
1189
+ description: List of flow changes
1190
+ required: true
1191
+ responses:
1192
+ '200':
1193
+ description: OK
1194
+ headers: {}
1195
+ content:
1196
+ application/json;charset=utf-8:
1197
+ schema:
1198
+ type: array
1199
+ items:
1200
+ $ref: '#/components/schemas/APIFlow'
1201
+ description: ''
1202
+ '400':
1203
+ description: Illegal request parameters
1204
+ headers: {}
1205
+ content: {}
1206
+ '403':
1207
+ description: The user is missing required permissions
1208
+ headers: {}
1209
+ content: {}
1210
+ '404':
1211
+ description: Application not found
1212
+ headers: {}
1213
+ content: {}
1214
+ deprecated: false
1215
+ /applications/{id}/flows/new:
1216
+ post:
1217
+ tags:
1218
+ - flows-api-controller
1219
+ summary: createApplicationFlowUsingPOST
1220
+ description: >-
1221
+ Usage example:
1222
+
1223
+ [
1224
+
1225
+  {
1226
+
1227
+   "type" : "APPLICATION",
1228
+
1229
+   "name": "string",
1230
+
1231
+   "sources": [
1232
+
1233
+    {
1234
+
1235
+     "name": "string", "device": "string"
1236
+
1237
+    }
1238
+
1239
+   ],
1240
+
1241
+   "destinations": [
1242
+
1243
+    {
1244
+
1245
+     "name": "string", "device": "string"
1246
+
1247
+    }
1248
+
1249
+   ],
1250
+
1251
+   "services": [
1252
+
1253
+    {
1254
+
1255
+     "name": "string", "device": "string"
1256
+
1257
+    }
1258
+
1259
+   ],
1260
+
1261
+   "users": [
1262
+
1263
+    {
1264
+
1265
+     "string"
1266
+
1267
+    }
1268
+
1269
+   ],
1270
+
1271
+   "network_applications": [
1272
+
1273
+    {
1274
+
1275
+     "name": "string", "device": "string"
1276
+
1277
+    }
1278
+
1279
+   ],
1280
+
1281
+   "comment": "string",
1282
+
1283
+   "custom_fields": [
1284
+
1285
+    {
1286
+
1287
+     "name": "string", "value": "string"
1288
+
1289
+    }
1290
+
1291
+   ]
1292
+
1293
+  },
1294
+
1295
+  {
1296
+
1297
+   "type": "SHARED",
1298
+
1299
+   "name": "string",
1300
+
1301
+   "sources": [
1302
+
1303
+    {
1304
+
1305
+     "name": "string", "device": "string"
1306
+
1307
+    }
1308
+
1309
+   ],
1310
+
1311
+   "services": [
1312
+
1313
+    {
1314
+
1315
+     "name": "string", "device": "string"
1316
+
1317
+    }
1318
+
1319
+   ]
1320
+
1321
+  },
1322
+
1323
+  {
1324
+
1325
+   "type": "SUBSCRIBED",
1326
+
1327
+   "shared_application_name": "string",
1328
+
1329
+   "subscribed_flows": [
1330
+
1331
+    {
1332
+
1333
+     "shared_flow_name": "string",
1334
+
1335
+     "placeholder_network_object": [
1336
+
1337
+      {
1338
+
1339
+       "name": "string", "device": "string"
1340
+
1341
+      }
1342
+
1343
+     ]
1344
+
1345
+    }
1346
+
1347
+   ]
1348
+
1349
+  }
1350
+
1351
+ ]
1352
+
1353
+
1354
+ Source/Destination examples: { "name": string, "device": string } OR { "objectID": number }
1355
+ operationId: createApplicationFlowUsingPOST
1356
+ parameters:
1357
+ - name: id
1358
+ in: path
1359
+ description: Application revision ID
1360
+ required: true
1361
+ style: simple
1362
+ schema:
1363
+ type: integer
1364
+ format: int32
1365
+ requestBody:
1366
+ description: List of new flows
1367
+ content:
1368
+ application/json:
1369
+ schema:
1370
+ type: array
1371
+ items:
1372
+ $ref: '#/components/schemas/APIAbstractFlowRequest'
1373
+ description: List of new flows
1374
+ required: true
1375
+ responses:
1376
+ '200':
1377
+ description: OK
1378
+ headers: {}
1379
+ content:
1380
+ application/json;charset=utf-8:
1381
+ schema:
1382
+ $ref: '#/components/schemas/ResponseEntity'
1383
+ '400':
1384
+ description: Illegal request parameters
1385
+ headers: {}
1386
+ content: {}
1387
+ '403':
1388
+ description: The user is missing required permissions
1389
+ headers: {}
1390
+ content: {}
1391
+ '404':
1392
+ description: Application not found
1393
+ headers: {}
1394
+ content: {}
1395
+ deprecated: false
1396
+ /applications/{id}/flows/{flowId}:
1397
+ get:
1398
+ tags:
1399
+ - flows-api-controller
1400
+ summary: getFlowUsingGET
1401
+ description: Retrieve an application flow by application ID and flow ID
1402
+ operationId: getFlowUsingGET
1403
+ parameters:
1404
+ - name: flowId
1405
+ in: path
1406
+ description: Flow ID
1407
+ required: true
1408
+ style: simple
1409
+ schema:
1410
+ type: integer
1411
+ format: int32
1412
+ - name: id
1413
+ in: path
1414
+ description: Application revision ID
1415
+ required: true
1416
+ style: simple
1417
+ schema:
1418
+ type: integer
1419
+ format: int32
1420
+ responses:
1421
+ '200':
1422
+ description: OK
1423
+ headers: {}
1424
+ content:
1425
+ application/json;charset=utf-8:
1426
+ schema:
1427
+ allOf:
1428
+ - $ref: '#/components/schemas/APIFlow'
1429
+ - description: Application flow data
1430
+ '403':
1431
+ description: The user is missing required permissions
1432
+ headers: {}
1433
+ content: {}
1434
+ '404':
1435
+ description: Application or flow not found
1436
+ headers: {}
1437
+ content: {}
1438
+ deprecated: false
1439
+ delete:
1440
+ tags:
1441
+ - flows-api-controller
1442
+ summary: deleteFlowByIdUsingDELETE
1443
+ description: Remove a flow by application ID and flow ID
1444
+ operationId: deleteFlowByIdUsingDELETE
1445
+ parameters:
1446
+ - name: flowId
1447
+ in: path
1448
+ description: Flow ID
1449
+ required: true
1450
+ style: simple
1451
+ schema:
1452
+ type: integer
1453
+ format: int32
1454
+ - name: id
1455
+ in: path
1456
+ description: Application revision ID
1457
+ required: true
1458
+ style: simple
1459
+ schema:
1460
+ type: integer
1461
+ format: int32
1462
+ responses:
1463
+ '200':
1464
+ description: OK
1465
+ headers: {}
1466
+ content:
1467
+ application/json;charset=utf-8:
1468
+ schema:
1469
+ $ref: '#/components/schemas/ResponseEntity'
1470
+ '400':
1471
+ description: Illegal request parameters
1472
+ headers: {}
1473
+ content: {}
1474
+ '403':
1475
+ description: The user is missing required permissions
1476
+ headers: {}
1477
+ content: {}
1478
+ '404':
1479
+ description: Application not found
1480
+ headers: {}
1481
+ content: {}
1482
+ deprecated: false
1483
+ /applications/{id}/flows/{flowId}/check_connectivity:
1484
+ post:
1485
+ tags:
1486
+ - flows-api-controller
1487
+ summary: runConnectivityOnFlowUsingPOST
1488
+ description: Check flow connectivity by application ID and flow ID
1489
+ operationId: runConnectivityOnFlowUsingPOST
1490
+ parameters:
1491
+ - name: flowId
1492
+ in: path
1493
+ description: Flow ID
1494
+ required: true
1495
+ style: simple
1496
+ schema:
1497
+ type: integer
1498
+ format: int32
1499
+ - name: id
1500
+ in: path
1501
+ description: Application revision ID
1502
+ required: true
1503
+ style: simple
1504
+ schema:
1505
+ type: integer
1506
+ format: int32
1507
+ - name: Content-Type
1508
+ in: header
1509
+ description: ''
1510
+ required: true
1511
+ style: simple
1512
+ schema:
1513
+ $ref: '#/components/schemas/Content-Type'
1514
+ responses:
1515
+ '200':
1516
+ description: OK
1517
+ headers: {}
1518
+ content:
1519
+ application/json;charset=utf-8:
1520
+ schema:
1521
+ allOf:
1522
+ - $ref: '#/components/schemas/APIFlowConnectivity'
1523
+ - description: Single flow connectivity status
1524
+ '403':
1525
+ description: The user is missing required permissions
1526
+ headers: {}
1527
+ content: {}
1528
+ '404':
1529
+ description: Application or flow not found
1530
+ headers: {}
1531
+ content: {}
1532
+ deprecated: false
1533
+ /applications/{id}/flows/{flowId}/risks:
1534
+ get:
1535
+ tags:
1536
+ - flows-api-controller
1537
+ summary: getFlowRisksUsingGET
1538
+ description: Retrieve a list of risks for a flow by application ID and flow ID
1539
+ operationId: getFlowRisksUsingGET
1540
+ parameters:
1541
+ - name: flowId
1542
+ in: path
1543
+ description: Flow ID
1544
+ required: true
1545
+ style: simple
1546
+ schema:
1547
+ type: integer
1548
+ format: int32
1549
+ - name: id
1550
+ in: path
1551
+ description: Application revision ID
1552
+ required: true
1553
+ style: simple
1554
+ schema:
1555
+ type: integer
1556
+ format: int32
1557
+ responses:
1558
+ '200':
1559
+ description: OK
1560
+ headers: {}
1561
+ content:
1562
+ application/json;charset=utf-8:
1563
+ schema:
1564
+ type: array
1565
+ items:
1566
+ $ref: '#/components/schemas/RestRisk'
1567
+ description: ''
1568
+ '403':
1569
+ description: The user is missing required permissions
1570
+ headers: {}
1571
+ content: {}
1572
+ '404':
1573
+ description: Application or flow not found
1574
+ headers: {}
1575
+ content: {}
1576
+ deprecated: false
1577
+ /network_objects/:
1578
+ get:
1579
+ tags:
1580
+ - network-object-api-controller
1581
+ summary: getAllNetworkObjectsUsingGET
1582
+ description: The response is a subset of the results in pages
1583
+ operationId: getAllNetworkObjectsUsingGET
1584
+ parameters:
1585
+ - name: page_number
1586
+ in: query
1587
+ description: The page number
1588
+ style: form
1589
+ explode: true
1590
+ schema:
1591
+ type: integer
1592
+ format: int32
1593
+ default: 1
1594
+ - name: page_size
1595
+ in: query
1596
+ description: The page size
1597
+ style: form
1598
+ explode: true
1599
+ schema:
1600
+ type: integer
1601
+ format: int32
1602
+ responses:
1603
+ '200':
1604
+ description: OK
1605
+ headers: {}
1606
+ content:
1607
+ application/json;charset=utf-8:
1608
+ schema:
1609
+ type: array
1610
+ items:
1611
+ $ref: '#/components/schemas/APINetworkObject'
1612
+ description: ''
1613
+ '403':
1614
+ description: Access Denied
1615
+ headers: {}
1616
+ content: {}
1617
+ deprecated: false
1618
+ /network_objects/find:
1619
+ get:
1620
+ tags:
1621
+ - network-object-api-controller
1622
+ summary: findNetworkObjectsByIpUsingGET
1623
+ description: 'Retrieve a list of filtered network objects '
1624
+ operationId: findNetworkObjectsByIpUsingGET
1625
+ parameters:
1626
+ - name: address
1627
+ in: query
1628
+ description: The address to query
1629
+ required: true
1630
+ style: form
1631
+ explode: true
1632
+ schema:
1633
+ type: string
1634
+ - name: type
1635
+ in: query
1636
+ description: The filter type
1637
+ style: form
1638
+ explode: true
1639
+ schema:
1640
+ allOf:
1641
+ - $ref: '#/components/schemas/type91'
1642
+ - description: The filter type
1643
+ responses:
1644
+ '200':
1645
+ description: OK
1646
+ headers: {}
1647
+ content:
1648
+ application/json;charset=utf-8:
1649
+ schema:
1650
+ type: array
1651
+ items:
1652
+ $ref: '#/components/schemas/APINetworkObject'
1653
+ description: ''
1654
+ '403':
1655
+ description: Access Denied
1656
+ headers: {}
1657
+ content: {}
1658
+ deprecated: false
1659
+ /network_objects/find/applications:
1660
+ get:
1661
+ tags:
1662
+ - network-object-api-controller
1663
+ summary: findNetworkObjectsApplicationsByIpUsingGET
1664
+ description: Retrieve a list of applications affected by filtered network objects
1665
+ operationId: findNetworkObjectsApplicationsByIpUsingGET
1666
+ parameters:
1667
+ - name: address
1668
+ in: query
1669
+ description: The address to search
1670
+ required: true
1671
+ style: form
1672
+ explode: true
1673
+ schema:
1674
+ type: string
1675
+ - name: type
1676
+ in: query
1677
+ description: The filter type
1678
+ style: form
1679
+ explode: true
1680
+ schema:
1681
+ allOf:
1682
+ - $ref: '#/components/schemas/type91'
1683
+ - description: The filter type
1684
+ responses:
1685
+ '200':
1686
+ description: OK
1687
+ headers: {}
1688
+ content:
1689
+ application/json;charset=utf-8:
1690
+ schema:
1691
+ type: array
1692
+ items:
1693
+ $ref: '#/components/schemas/APIApplication'
1694
+ description: ''
1695
+ '403':
1696
+ description: Access Denied
1697
+ headers: {}
1698
+ content: {}
1699
+ deprecated: false
1700
+ /network_objects/name/**:
1701
+ get:
1702
+ tags:
1703
+ - network-object-api-controller
1704
+ summary: getNetworkObjectsByNameUsingGET
1705
+ description: This API cannot be tested in Swagger
1706
+ operationId: getNetworkObjectsByNameUsingGET
1707
+ parameters: []
1708
+ responses:
1709
+ '200':
1710
+ description: OK
1711
+ headers: {}
1712
+ content:
1713
+ application/json;charset=utf-8:
1714
+ schema:
1715
+ type: array
1716
+ items:
1717
+ $ref: '#/components/schemas/APINetworkObject'
1718
+ description: ''
1719
+ '403':
1720
+ description: Access Denied
1721
+ headers: {}
1722
+ content: {}
1723
+ deprecated: false
1724
+ /network_objects/new:
1725
+ post:
1726
+ tags:
1727
+ - network-object-api-controller
1728
+ summary: createNewEndpointUsingPOST
1729
+ description: Create a new network object
1730
+ operationId: createNewEndpointUsingPOST
1731
+ parameters:
1732
+ - name: csv
1733
+ in: query
1734
+ description: csv
1735
+ style: form
1736
+ explode: true
1737
+ schema:
1738
+ type: boolean
1739
+ default: true
1740
+ requestBody:
1741
+ description: "Data for network object. Examples models: 'New host/range network object' | 'New network object group' | 'New abstract network object'"
1742
+ content:
1743
+ application/json:
1744
+ schema:
1745
+ allOf:
1746
+ - $ref: '#/components/schemas/NetworkObjectsNewRequest'
1747
+ - description: "Data for network object. Examples models: 'New host/range network object' | 'New network object group' | 'New abstract network object'"
1748
+ required: true
1749
+ responses:
1750
+ '200':
1751
+ description: OK
1752
+ headers: {}
1753
+ content:
1754
+ application/json;charset=utf-8:
1755
+ schema:
1756
+ $ref: '#/components/schemas/ResponseEntity'
1757
+ '400':
1758
+ description: Illegal request parameters
1759
+ headers: {}
1760
+ content: {}
1761
+ '403':
1762
+ description: User is missing required permissions
1763
+ headers: {}
1764
+ content: {}
1765
+ deprecated: false
1766
+ /network_objects/{id}:
1767
+ get:
1768
+ tags:
1769
+ - network-object-api-controller
1770
+ summary: getNetworkObjectByIdUsingGET
1771
+ description: Retrieve a network object by ID
1772
+ operationId: getNetworkObjectByIdUsingGET
1773
+ parameters:
1774
+ - name: id
1775
+ in: path
1776
+ description: Network object id
1777
+ required: true
1778
+ style: simple
1779
+ schema:
1780
+ type: integer
1781
+ format: int32
1782
+ responses:
1783
+ '200':
1784
+ description: OK
1785
+ headers: {}
1786
+ content:
1787
+ application/json;charset=utf-8:
1788
+ schema:
1789
+ allOf:
1790
+ - $ref: '#/components/schemas/APINetworkObject'
1791
+ - description: Network object data
1792
+ '403':
1793
+ description: Access Denied
1794
+ headers: {}
1795
+ content: {}
1796
+ '404':
1797
+ description: Network object not found
1798
+ headers: {}
1799
+ content: {}
1800
+ deprecated: false
1801
+ post:
1802
+ tags:
1803
+ - network-object-api-controller
1804
+ summary: editEndpointUsingPOST
1805
+ description: Edit a network object
1806
+ operationId: editEndpointUsingPOST
1807
+ parameters:
1808
+ - name: id
1809
+ in: path
1810
+ description: Network object id
1811
+ required: true
1812
+ style: simple
1813
+ schema:
1814
+ type: integer
1815
+ format: int32
1816
+ requestBody:
1817
+ description: Network object content
1818
+ content:
1819
+ application/json:
1820
+ schema:
1821
+ allOf:
1822
+ - $ref: '#/components/schemas/NetworkObjectsRequest'
1823
+ - description: Network object content
1824
+ required: true
1825
+ responses:
1826
+ '200':
1827
+ description: OK
1828
+ headers: {}
1829
+ content:
1830
+ application/json;charset=utf-8:
1831
+ schema:
1832
+ allOf:
1833
+ - $ref: '#/components/schemas/APIEditedEndpoint'
1834
+ - description: Edit network object results
1835
+ '400':
1836
+ description: Illegal request parameters
1837
+ headers: {}
1838
+ content: {}
1839
+ '403':
1840
+ description: User is missing required permissions
1841
+ headers: {}
1842
+ content: {}
1843
+ deprecated: false
1844
+ delete:
1845
+ tags:
1846
+ - network-object-api-controller
1847
+ summary: deleteNetworkObjectByIdUsingDELETE
1848
+ description: Remove a network object by ID
1849
+ operationId: deleteNetworkObjectByIdUsingDELETE
1850
+ parameters:
1851
+ - name: id
1852
+ in: path
1853
+ description: Network object id
1854
+ required: true
1855
+ style: simple
1856
+ schema:
1857
+ type: integer
1858
+ format: int32
1859
+ responses:
1860
+ '200':
1861
+ description: OK
1862
+ headers: {}
1863
+ content:
1864
+ application/json;charset=utf-8:
1865
+ schema:
1866
+ allOf:
1867
+ - $ref: '#/components/schemas/APIDeleteResponse'
1868
+ - description: Delete network object results
1869
+ '403':
1870
+ description: The user is missing required permissions
1871
+ headers: {}
1872
+ content: {}
1873
+ '404':
1874
+ description: Network object not found
1875
+ headers: {}
1876
+ content: {}
1877
+ '500':
1878
+ description: Object deletion failed
1879
+ headers: {}
1880
+ content: {}
1881
+ deprecated: false
1882
+ /network_objects/{id}/applications:
1883
+ get:
1884
+ tags:
1885
+ - network-object-api-controller
1886
+ summary: getNetworkObjectApplicationsUsingGET
1887
+ description: Get a list of applications affected by a network object
1888
+ operationId: getNetworkObjectApplicationsUsingGET
1889
+ parameters:
1890
+ - name: id
1891
+ in: path
1892
+ description: Network object id
1893
+ required: true
1894
+ style: simple
1895
+ schema:
1896
+ type: integer
1897
+ format: int32
1898
+ responses:
1899
+ '200':
1900
+ description: OK
1901
+ headers: {}
1902
+ content:
1903
+ application/json;charset=utf-8:
1904
+ schema:
1905
+ type: array
1906
+ items:
1907
+ $ref: '#/components/schemas/APIApplication'
1908
+ description: ''
1909
+ '403':
1910
+ description: Access Denied
1911
+ headers: {}
1912
+ content: {}
1913
+ '404':
1914
+ description: Network object not found
1915
+ headers: {}
1916
+ content: {}
1917
+ deprecated: false
1918
+ /network_objects/{id}/replace:
1919
+ post:
1920
+ tags:
1921
+ - network-object-api-controller
1922
+ summary: replaceAbstractEndpointUsingPOST
1923
+ description: Replace an abstract network object
1924
+ operationId: replaceAbstractEndpointUsingPOST
1925
+ parameters:
1926
+ - name: id
1927
+ in: path
1928
+ description: Network object ID
1929
+ required: true
1930
+ style: simple
1931
+ schema:
1932
+ type: integer
1933
+ format: int32
1934
+ requestBody:
1935
+ description: Data for replacement of abstract object
1936
+ content:
1937
+ application/json:
1938
+ schema:
1939
+ allOf:
1940
+ - $ref: '#/components/schemas/NetworkObjectsReplaceRequest'
1941
+ - description: Data for replacement of abstract object
1942
+ required: true
1943
+ responses:
1944
+ '200':
1945
+ description: OK
1946
+ headers: {}
1947
+ content:
1948
+ application/json;charset=utf-8:
1949
+ schema:
1950
+ allOf:
1951
+ - $ref: '#/components/schemas/APIReplaceAbstractObjectResponse'
1952
+ - description: Replace abstract object action results
1953
+ '400':
1954
+ description: Illegal request parameters
1955
+ headers: {}
1956
+ content: {}
1957
+ '403':
1958
+ description: User is missing required permissions
1959
+ headers: {}
1960
+ content: {}
1961
+ deprecated: false
1962
+ /network_objects/{id}/save_labels:
1963
+ post:
1964
+ tags:
1965
+ - network-object-api-controller
1966
+ summary: saveEndpointLabelsUsingPOST
1967
+ description: saveEndpointLabels
1968
+ operationId: saveEndpointLabelsUsingPOST
1969
+ parameters:
1970
+ - name: id
1971
+ in: path
1972
+ description: id
1973
+ required: true
1974
+ style: simple
1975
+ schema:
1976
+ type: integer
1977
+ format: int32
1978
+ requestBody:
1979
+ description: labelsRequest
1980
+ content:
1981
+ application/json:
1982
+ schema:
1983
+ allOf:
1984
+ - $ref: '#/components/schemas/NetworkObjectsSaveLabelsRequest'
1985
+ - description: labelsRequest
1986
+ required: true
1987
+ responses:
1988
+ '200':
1989
+ description: OK
1990
+ headers: {}
1991
+ content:
1992
+ application/json;charset=utf-8:
1993
+ schema:
1994
+ $ref: '#/components/schemas/ResponseEntity'
1995
+ deprecated: false
1996
+ /network_objects/{id}/sync:
1997
+ post:
1998
+ tags:
1999
+ - network-object-api-controller
2000
+ summary: syncEndpointUsingPOST
2001
+ description: Syncing (update) an network object from device
2002
+ operationId: syncEndpointUsingPOST
2003
+ parameters:
2004
+ - name: id
2005
+ in: path
2006
+ description: Network object ID
2007
+ required: true
2008
+ style: simple
2009
+ schema:
2010
+ type: integer
2011
+ format: int32
2012
+ - name: Content-Type
2013
+ in: header
2014
+ description: ''
2015
+ required: true
2016
+ style: simple
2017
+ schema:
2018
+ $ref: '#/components/schemas/Content-Type'
2019
+ responses:
2020
+ '200':
2021
+ description: OK
2022
+ headers: {}
2023
+ content:
2024
+ application/json;charset=utf-8:
2025
+ schema:
2026
+ $ref: '#/components/schemas/Status'
2027
+ '400':
2028
+ description: Illegal request parameters
2029
+ headers: {}
2030
+ content: {}
2031
+ '403':
2032
+ description: User is missing required permissions
2033
+ headers: {}
2034
+ content: {}
2035
+ deprecated: false
2036
+ /network_objects/{id}/vulnerabilities:
2037
+ get:
2038
+ tags:
2039
+ - network-object-api-controller
2040
+ summary: getNetworkObjectVulnerabilitiesUsingGET
2041
+ description: Retrieve vulnerabilities for a network object
2042
+ operationId: getNetworkObjectVulnerabilitiesUsingGET
2043
+ parameters:
2044
+ - name: id
2045
+ in: path
2046
+ description: Network object id
2047
+ required: true
2048
+ style: simple
2049
+ schema:
2050
+ type: integer
2051
+ format: int32
2052
+ responses:
2053
+ '200':
2054
+ description: OK
2055
+ headers: {}
2056
+ content:
2057
+ application/json;charset=utf-8:
2058
+ schema:
2059
+ allOf:
2060
+ - $ref: '#/components/schemas/RestObjectVulnerability'
2061
+ - description: Network object vulnerability
2062
+ '403':
2063
+ description: Access Denied
2064
+ headers: {}
2065
+ content: {}
2066
+ '404':
2067
+ description: Network object not found
2068
+ headers: {}
2069
+ content: {}
2070
+ deprecated: false
2071
+ /network_services/:
2072
+ get:
2073
+ tags:
2074
+ - network-service-api-controller
2075
+ summary: getAllNetworkServicesUsingGET
2076
+ description: The response is a subset of the results in pages
2077
+ operationId: getAllNetworkServicesUsingGET
2078
+ parameters:
2079
+ - name: page_number
2080
+ in: query
2081
+ description: The page number
2082
+ style: form
2083
+ explode: true
2084
+ schema:
2085
+ type: integer
2086
+ format: int32
2087
+ default: 1
2088
+ - name: page_size
2089
+ in: query
2090
+ description: The page size
2091
+ style: form
2092
+ explode: true
2093
+ schema:
2094
+ type: integer
2095
+ format: int32
2096
+ responses:
2097
+ '200':
2098
+ description: OK
2099
+ headers: {}
2100
+ content:
2101
+ application/json;charset=utf-8:
2102
+ schema:
2103
+ type: array
2104
+ items:
2105
+ $ref: '#/components/schemas/APINetworkService'
2106
+ description: ''
2107
+ '403':
2108
+ description: Access Denied
2109
+ headers: {}
2110
+ content: {}
2111
+ deprecated: false
2112
+ /network_services/name/**:
2113
+ get:
2114
+ tags:
2115
+ - network-service-api-controller
2116
+ summary: getNetworkServiceByNameUsingGET
2117
+ description: This API cannot be tested in Swagger
2118
+ operationId: getNetworkServiceByNameUsingGET
2119
+ parameters: []
2120
+ responses:
2121
+ '200':
2122
+ description: OK
2123
+ headers: {}
2124
+ content:
2125
+ application/json;charset=utf-8:
2126
+ schema:
2127
+ allOf:
2128
+ - $ref: '#/components/schemas/APINetworkService'
2129
+ - description: Network Service
2130
+ '403':
2131
+ description: Access denied
2132
+ headers: {}
2133
+ content: {}
2134
+ deprecated: false
2135
+ /network_services/new:
2136
+ post:
2137
+ tags:
2138
+ - network-service-api-controller
2139
+ summary: createNewNetworkServiceUsingPOST
2140
+ description: Create a new network service
2141
+ operationId: createNewNetworkServiceUsingPOST
2142
+ parameters: []
2143
+ requestBody:
2144
+ description: Data for new network service
2145
+ content:
2146
+ application/json:
2147
+ schema:
2148
+ allOf:
2149
+ - $ref: '#/components/schemas/NetworkServicesNewRequest'
2150
+ - description: Data for new network service
2151
+ required: true
2152
+ responses:
2153
+ '200':
2154
+ description: OK
2155
+ headers: {}
2156
+ content:
2157
+ application/json;charset=utf-8:
2158
+ schema:
2159
+ allOf:
2160
+ - $ref: '#/components/schemas/APINetworkService'
2161
+ - description: Network Service
2162
+ '400':
2163
+ description: Invalid request parameters
2164
+ headers: {}
2165
+ content: {}
2166
+ '403':
2167
+ description: The user is missing required permissions
2168
+ headers: {}
2169
+ content: {}
2170
+ deprecated: false
2171
+ /network_services/{id}:
2172
+ get:
2173
+ tags:
2174
+ - network-service-api-controller
2175
+ summary: getNetworkServiceByIdUsingGET
2176
+ description: Retrieve a network service by ID
2177
+ operationId: getNetworkServiceByIdUsingGET
2178
+ parameters:
2179
+ - name: id
2180
+ in: path
2181
+ description: Network service ID
2182
+ required: true
2183
+ style: simple
2184
+ schema:
2185
+ type: integer
2186
+ format: int32
2187
+ responses:
2188
+ '200':
2189
+ description: OK
2190
+ headers: {}
2191
+ content:
2192
+ application/json;charset=utf-8:
2193
+ schema:
2194
+ allOf:
2195
+ - $ref: '#/components/schemas/APINetworkService'
2196
+ - description: Network Service
2197
+ '403':
2198
+ description: The user is missing required permissions
2199
+ headers: {}
2200
+ content: {}
2201
+ '404':
2202
+ description: Network service not found
2203
+ headers: {}
2204
+ content: {}
2205
+ deprecated: false
2206
+ post:
2207
+ tags:
2208
+ - network-service-api-controller
2209
+ summary: editNetworkServiceUsingPOST
2210
+ description: Edit a network service object
2211
+ operationId: editNetworkServiceUsingPOST
2212
+ parameters:
2213
+ - name: id
2214
+ in: path
2215
+ description: Network service ID
2216
+ required: true
2217
+ style: simple
2218
+ schema:
2219
+ type: integer
2220
+ format: int32
2221
+ requestBody:
2222
+ description: Data for network service
2223
+ content:
2224
+ application/json:
2225
+ schema:
2226
+ allOf:
2227
+ - $ref: '#/components/schemas/NetworkServicesRequest'
2228
+ - description: Data for network service
2229
+ required: true
2230
+ responses:
2231
+ '200':
2232
+ description: OK
2233
+ headers: {}
2234
+ content:
2235
+ application/json;charset=utf-8:
2236
+ schema:
2237
+ allOf:
2238
+ - $ref: '#/components/schemas/APINetworkService'
2239
+ - description: Network Service
2240
+ '400':
2241
+ description: Invalid request parameters
2242
+ headers: {}
2243
+ content: {}
2244
+ '403':
2245
+ description: The user is missing required permissions
2246
+ headers: {}
2247
+ content: {}
2248
+ '404':
2249
+ description: Network service not found
2250
+ headers: {}
2251
+ content: {}
2252
+ deprecated: false
2253
+ delete:
2254
+ tags:
2255
+ - network-service-api-controller
2256
+ summary: deleteNetworkServiceByIdUsingDELETE
2257
+ description: Remove a network service
2258
+ operationId: deleteNetworkServiceByIdUsingDELETE
2259
+ parameters:
2260
+ - name: id
2261
+ in: path
2262
+ description: Network service ID
2263
+ required: true
2264
+ style: simple
2265
+ schema:
2266
+ type: integer
2267
+ format: int32
2268
+ responses:
2269
+ '200':
2270
+ description: OK
2271
+ headers: {}
2272
+ content:
2273
+ application/json;charset=utf-8:
2274
+ schema:
2275
+ $ref: '#/components/schemas/RestStatus'
2276
+ '403':
2277
+ description: The user is missing required permissions
2278
+ headers: {}
2279
+ content: {}
2280
+ '404':
2281
+ description: Network service not found
2282
+ headers: {}
2283
+ content: {}
2284
+ '500':
2285
+ description: Failed to delete network service
2286
+ headers: {}
2287
+ content: {}
2288
+ deprecated: false
2289
+ /network_services/{id}/sync:
2290
+ post:
2291
+ tags:
2292
+ - network-service-api-controller
2293
+ summary: syncServiceObjectUsingPOST
2294
+ description: Syncing (update) an service object from device
2295
+ operationId: syncServiceObjectUsingPOST
2296
+ parameters:
2297
+ - name: id
2298
+ in: path
2299
+ description: Service object ID
2300
+ required: true
2301
+ style: simple
2302
+ schema:
2303
+ type: integer
2304
+ format: int32
2305
+ - name: Content-Type
2306
+ in: header
2307
+ description: ''
2308
+ required: true
2309
+ style: simple
2310
+ schema:
2311
+ $ref: '#/components/schemas/Content-Type'
2312
+ responses:
2313
+ '200':
2314
+ description: OK
2315
+ headers: {}
2316
+ content:
2317
+ application/json;charset=utf-8:
2318
+ schema:
2319
+ $ref: '#/components/schemas/Status'
2320
+ '400':
2321
+ description: Illegal request parameters
2322
+ headers: {}
2323
+ content: {}
2324
+ '403':
2325
+ description: User is missing required permissions
2326
+ headers: {}
2327
+ content: {}
2328
+ deprecated: false
2329
+ /settings/permissions/default:
2330
+ get:
2331
+ tags:
2332
+ - permissions-api-controller
2333
+ summary: getDefaultPermissionsUsingGET
2334
+ description: Retrieve the default permissions of new users
2335
+ operationId: getDefaultPermissionsUsingGET
2336
+ parameters: []
2337
+ responses:
2338
+ '200':
2339
+ description: OK
2340
+ headers: {}
2341
+ content:
2342
+ application/json;charset=utf-8:
2343
+ schema:
2344
+ allOf:
2345
+ - $ref: '#/components/schemas/APIDefaultPermissions'
2346
+ - description: User permissions data
2347
+ '403':
2348
+ description: The user is missing required permissions
2349
+ headers: {}
2350
+ content: {}
2351
+ deprecated: false
2352
+ /settings/permissions/role:
2353
+ get:
2354
+ tags:
2355
+ - permissions-api-controller
2356
+ summary: getRoleUsingGET
2357
+ description: Retrieve permissions of a role name
2358
+ operationId: getRoleUsingGET
2359
+ parameters:
2360
+ - name: name
2361
+ in: query
2362
+ description: Case-sensitive role name
2363
+ required: true
2364
+ style: form
2365
+ explode: true
2366
+ schema:
2367
+ type: string
2368
+ responses:
2369
+ '200':
2370
+ description: OK
2371
+ headers: {}
2372
+ content:
2373
+ application/json;charset=utf-8:
2374
+ schema:
2375
+ allOf:
2376
+ - $ref: '#/components/schemas/APIRoleEntityPermissions'
2377
+ - description: Role permissions
2378
+ '403':
2379
+ description: The user is missing required permissions
2380
+ headers: {}
2381
+ content: {}
2382
+ '404':
2383
+ description: Cannot find role
2384
+ headers: {}
2385
+ content: {}
2386
+ deprecated: false
2387
+ post:
2388
+ tags:
2389
+ - permissions-api-controller
2390
+ summary: changeRolePermissionsUsingPOST
2391
+ description: Update permissions and users for a role
2392
+ operationId: changeRolePermissionsUsingPOST
2393
+ parameters:
2394
+ - name: name
2395
+ in: query
2396
+ description: Case-sensitive role name
2397
+ required: true
2398
+ style: form
2399
+ explode: true
2400
+ schema:
2401
+ type: string
2402
+ requestBody:
2403
+ description: Data for role change
2404
+ content:
2405
+ application/json:
2406
+ schema:
2407
+ allOf:
2408
+ - $ref: '#/components/schemas/SettingsPermissionsRoleRequest'
2409
+ - description: Data for role change
2410
+ required: true
2411
+ responses:
2412
+ '200':
2413
+ description: OK
2414
+ headers: {}
2415
+ content:
2416
+ application/json;charset=utf-8:
2417
+ schema:
2418
+ allOf:
2419
+ - $ref: '#/components/schemas/APIRoleEntityPermissions'
2420
+ - description: Role permissions
2421
+ '400':
2422
+ description: Invalid request parameters
2423
+ headers: {}
2424
+ content: {}
2425
+ '403':
2426
+ description: The user is missing required permissions
2427
+ headers: {}
2428
+ content: {}
2429
+ deprecated: false
2430
+ delete:
2431
+ tags:
2432
+ - permissions-api-controller
2433
+ summary: deleteRoleUsingDELETE
2434
+ description: Remove a role
2435
+ operationId: deleteRoleUsingDELETE
2436
+ parameters:
2437
+ - name: name
2438
+ in: query
2439
+ description: Case-sensitive role name
2440
+ required: true
2441
+ style: form
2442
+ explode: true
2443
+ schema:
2444
+ type: string
2445
+ responses:
2446
+ '200':
2447
+ description: OK
2448
+ headers: {}
2449
+ content:
2450
+ application/json;charset=utf-8:
2451
+ schema:
2452
+ $ref: '#/components/schemas/ResponseEntity'
2453
+ '403':
2454
+ description: The user is missing required permissions
2455
+ headers: {}
2456
+ content: {}
2457
+ '404':
2458
+ description: Cannot find role
2459
+ headers: {}
2460
+ content: {}
2461
+ deprecated: false
2462
+ /settings/permissions/role/new:
2463
+ post:
2464
+ tags:
2465
+ - permissions-api-controller
2466
+ summary: createRoleUsingPOST
2467
+ description: Create a new role
2468
+ operationId: createRoleUsingPOST
2469
+ parameters: []
2470
+ requestBody:
2471
+ description: Case-sensitive role name
2472
+ content:
2473
+ application/json:
2474
+ schema:
2475
+ allOf:
2476
+ - $ref: '#/components/schemas/SettingsPermissionsRoleNewRequest'
2477
+ - description: Case-sensitive role name
2478
+ required: true
2479
+ responses:
2480
+ '200':
2481
+ description: OK
2482
+ headers: {}
2483
+ content:
2484
+ application/json;charset=utf-8:
2485
+ schema:
2486
+ allOf:
2487
+ - $ref: '#/components/schemas/APIRoleEntityPermissions'
2488
+ - description: Role permissions
2489
+ '400':
2490
+ description: Invalid request parameters
2491
+ headers: {}
2492
+ content: {}
2493
+ '403':
2494
+ description: The user is missing required permissions
2495
+ headers: {}
2496
+ content: {}
2497
+ deprecated: false
2498
+ /settings/permissions/user:
2499
+ get:
2500
+ tags:
2501
+ - permissions-api-controller
2502
+ summary: getUserPermissionsUsingGET
2503
+ description: Retrieve user permissions for a user name
2504
+ operationId: getUserPermissionsUsingGET
2505
+ parameters:
2506
+ - name: name
2507
+ in: query
2508
+ description: Case-sensitive user name
2509
+ required: true
2510
+ style: form
2511
+ explode: true
2512
+ schema:
2513
+ type: string
2514
+ responses:
2515
+ '200':
2516
+ description: OK
2517
+ headers: {}
2518
+ content:
2519
+ application/json;charset=utf-8:
2520
+ schema:
2521
+ allOf:
2522
+ - $ref: '#/components/schemas/APIUserEntityPermissions'
2523
+ - description: User permissions
2524
+ '403':
2525
+ description: The user is missing required permissions
2526
+ headers: {}
2527
+ content: {}
2528
+ '404':
2529
+ description: Cannot find user
2530
+ headers: {}
2531
+ content: {}
2532
+ deprecated: false
2533
+ post:
2534
+ tags:
2535
+ - permissions-api-controller
2536
+ summary: changeUserPermissionsUsingPOST
2537
+ description: Update permissions for a user
2538
+ operationId: changeUserPermissionsUsingPOST
2539
+ parameters:
2540
+ - name: name
2541
+ in: query
2542
+ description: Case-sensitive user name
2543
+ required: true
2544
+ style: form
2545
+ explode: true
2546
+ schema:
2547
+ type: string
2548
+ requestBody:
2549
+ description: Permissions data
2550
+ content:
2551
+ application/json:
2552
+ schema:
2553
+ allOf:
2554
+ - $ref: '#/components/schemas/SettingsPermissionsUserRequest'
2555
+ - description: Permissions data
2556
+ required: true
2557
+ responses:
2558
+ '200':
2559
+ description: OK
2560
+ headers: {}
2561
+ content:
2562
+ application/json;charset=utf-8:
2563
+ schema:
2564
+ allOf:
2565
+ - $ref: '#/components/schemas/APIUserEntityPermissions'
2566
+ - description: User permissions
2567
+ '400':
2568
+ description: Invalid request parameters
2569
+ headers: {}
2570
+ content: {}
2571
+ '403':
2572
+ description: The user is missing required permissions
2573
+ headers: {}
2574
+ content: {}
2575
+ deprecated: false
2576
+ /settings/permissions/user/permitted_applications:
2577
+ get:
2578
+ tags:
2579
+ - permissions-api-controller
2580
+ summary: getUserPermittedApplicationsUsingGET
2581
+ description: Retrieve whether a user has permissions for an application – For use by admin users
2582
+ operationId: getUserPermittedApplicationsUsingGET
2583
+ parameters:
2584
+ - name: id
2585
+ in: query
2586
+ description: Application revision ID
2587
+ required: true
2588
+ style: form
2589
+ explode: true
2590
+ schema:
2591
+ type: integer
2592
+ format: int32
2593
+ - name: name
2594
+ in: query
2595
+ description: Case-sensitive user name
2596
+ required: true
2597
+ style: form
2598
+ explode: true
2599
+ schema:
2600
+ type: string
2601
+ responses:
2602
+ '200':
2603
+ description: OK
2604
+ headers: {}
2605
+ content:
2606
+ application/json;charset=utf-8:
2607
+ schema:
2608
+ type: boolean
2609
+ '403':
2610
+ description: The user is missing required permissions
2611
+ headers: {}
2612
+ content: {}
2613
+ '404':
2614
+ description: User or application not found
2615
+ headers: {}
2616
+ content: {}
2617
+ deprecated: false
2618
+ components:
2619
+ schemas:
2620
+ APIAbstractFlowRequest:
2621
+ title: APIAbstractFlowRequest
2622
+ required:
2623
+ - type
2624
+ type: object
2625
+ properties:
2626
+ type:
2627
+ type: string
2628
+ description: Application flow type
2629
+ discriminator:
2630
+ propertyName: type
2631
+ mapping:
2632
+ APIFlowRequest: APIFlowRequest
2633
+ APISubscribedFlowRequest: APISubscribedFlowRequest
2634
+ APIApplication:
2635
+ title: APIApplication
2636
+ type: object
2637
+ properties:
2638
+ applicationID:
2639
+ type: integer
2640
+ description: First application revision id
2641
+ format: int32
2642
+ connectivityStatus:
2643
+ type: string
2644
+ description: Application flows connectivity status
2645
+ contacts:
2646
+ type: array
2647
+ items:
2648
+ $ref: '#/components/schemas/RestApplicationPersonRole'
2649
+ description: List of application contacts
2650
+ createdDate:
2651
+ $ref: '#/components/schemas/Calendar'
2652
+ customFields:
2653
+ type: array
2654
+ items:
2655
+ $ref: '#/components/schemas/APIProperty'
2656
+ description: List of application custom field values
2657
+ expirationDate:
2658
+ $ref: '#/components/schemas/Calendar'
2659
+ labels:
2660
+ type: array
2661
+ items:
2662
+ $ref: '#/components/schemas/APILabel'
2663
+ description: List of application tags
2664
+ lastRiskCheck:
2665
+ $ref: '#/components/schemas/Calendar'
2666
+ lastUpdateDate:
2667
+ $ref: '#/components/schemas/Calendar'
2668
+ lifecyclePhase:
2669
+ type: string
2670
+ description: Application lifecycle phase
2671
+ name:
2672
+ type: string
2673
+ description: Application name
2674
+ revisionID:
2675
+ type: integer
2676
+ description: Application revision id
2677
+ format: int32
2678
+ revisionStatus:
2679
+ type: string
2680
+ description: Application revision status
2681
+ riskScore:
2682
+ type: integer
2683
+ description: Risk score for application flows
2684
+ format: int32
2685
+ vulnerabilityScore:
2686
+ type: integer
2687
+ description: Vulnerability score for application flows
2688
+ format: int32
2689
+ description: Application data
2690
+ APIApplicationActivityLog:
2691
+ title: APIApplicationActivityLog
2692
+ type: object
2693
+ properties:
2694
+ applicationName:
2695
+ type: string
2696
+ description: Application name
2697
+ category:
2698
+ type: string
2699
+ description: Activity category
2700
+ date:
2701
+ type: string
2702
+ description: Activity date
2703
+ format: date-time
2704
+ description:
2705
+ type: string
2706
+ description: Activity description
2707
+ userName:
2708
+ type: string
2709
+ description: Activity user name
2710
+ description: Application activity log entry
2711
+ APIApplicationApplyRequest:
2712
+ title: APIApplicationApplyRequest
2713
+ type: object
2714
+ properties:
2715
+ selectedFlowsIds:
2716
+ type: array
2717
+ items:
2718
+ type: integer
2719
+ format: int32
2720
+ description: ''
2721
+ description: Apply application data
2722
+ APIApplicationContact:
2723
+ title: APIApplicationContact
2724
+ type: object
2725
+ properties:
2726
+ email:
2727
+ type: string
2728
+ description: Contact e-mail address
2729
+ role:
2730
+ type: string
2731
+ description: The contact role in the application
2732
+ APIApplicationPermission:
2733
+ title: APIApplicationPermission
2734
+ type: object
2735
+ properties:
2736
+ applicationID:
2737
+ type: integer
2738
+ description: Application revision id
2739
+ format: int32
2740
+ permission:
2741
+ $ref: '#/components/schemas/Permission'
2742
+ description: Application permission data
2743
+ APIApplicationPermissionChange:
2744
+ title: APIApplicationPermissionChange
2745
+ type: object
2746
+ properties:
2747
+ add:
2748
+ type: array
2749
+ items:
2750
+ $ref: '#/components/schemas/APIApplicationPermission'
2751
+ description: Application permissions to add
2752
+ remove:
2753
+ type: array
2754
+ items:
2755
+ type: integer
2756
+ format: int32
2757
+ description: Application permissions to remove
2758
+ description: Application permission change data
2759
+ APIApplicationPermissionDefinition:
2760
+ title: APIApplicationPermissionDefinition
2761
+ type: object
2762
+ properties:
2763
+ name:
2764
+ type: string
2765
+ description: Permission name
2766
+ permission:
2767
+ $ref: '#/components/schemas/Permission1'
2768
+ type:
2769
+ $ref: '#/components/schemas/Type1'
2770
+ description: Application permission
2771
+ APIApplicationPermittedEntities:
2772
+ title: APIApplicationPermittedEntities
2773
+ type: object
2774
+ properties:
2775
+ applicationName:
2776
+ type: string
2777
+ description: Application name
2778
+ rolesEdit:
2779
+ type: array
2780
+ items:
2781
+ type: string
2782
+ description: List of role names with application edit permissions
2783
+ rolesView:
2784
+ type: array
2785
+ items:
2786
+ type: string
2787
+ description: List of role names with application view permissions
2788
+ usersEdit:
2789
+ type: array
2790
+ items:
2791
+ type: string
2792
+ description: List of user names with application edit permissions
2793
+ usersView:
2794
+ type: array
2795
+ items:
2796
+ type: string
2797
+ description: List of user names with application view permissions
2798
+ description: Application users and roles permissions
2799
+ APIApplicationRequest:
2800
+ title: APIApplicationRequest
2801
+ type: object
2802
+ properties:
2803
+ contacts:
2804
+ type: array
2805
+ items:
2806
+ $ref: '#/components/schemas/APIApplicationContact'
2807
+ description: List of contacts and roles
2808
+ custom_fields:
2809
+ type: array
2810
+ items:
2811
+ $ref: '#/components/schemas/APICustomFieldRequest'
2812
+ description: List of custom field values
2813
+ flows:
2814
+ type: array
2815
+ items:
2816
+ $ref: '#/components/schemas/APIAbstractFlowRequest'
2817
+ description: List of flows
2818
+ labels:
2819
+ type: array
2820
+ items:
2821
+ type: string
2822
+ description: List of tags
2823
+ name:
2824
+ type: string
2825
+ description: Application name
2826
+ permissions:
2827
+ type: array
2828
+ items:
2829
+ $ref: '#/components/schemas/APIApplicationPermissionDefinition'
2830
+ description: List of permissions
2831
+ description: New application data
2832
+ APICustomFieldRequest:
2833
+ title: APICustomFieldRequest
2834
+ type: object
2835
+ properties:
2836
+ name:
2837
+ type: string
2838
+ description: Custom field name
2839
+ value:
2840
+ type: string
2841
+ description: Custom field value
2842
+ description: Custom field to set
2843
+ APIDefaultPermissions:
2844
+ title: APIDefaultPermissions
2845
+ type: object
2846
+ properties:
2847
+ privileged:
2848
+ type: array
2849
+ items:
2850
+ $ref: '#/components/schemas/APIGlobalPermission'
2851
+ description: List of privileged user permissions
2852
+ requestor:
2853
+ type: array
2854
+ items:
2855
+ $ref: '#/components/schemas/APIGlobalPermission'
2856
+ description: List of requestor user permissions
2857
+ description: User permissions data
2858
+ APIDeleteResponse:
2859
+ title: APIDeleteResponse
2860
+ type: object
2861
+ properties:
2862
+ changeRequest:
2863
+ $ref: '#/components/schemas/ChangeRequest'
2864
+ errors:
2865
+ type: object
2866
+ message:
2867
+ type: string
2868
+ networkObject:
2869
+ $ref: '#/components/schemas/NetworkObject'
2870
+ success:
2871
+ type: boolean
2872
+ description: Delete network object results
2873
+ APIEditApplicationContactsRequest:
2874
+ title: APIEditApplicationContactsRequest
2875
+ type: object
2876
+ properties:
2877
+ addContacts:
2878
+ type: array
2879
+ items:
2880
+ $ref: '#/components/schemas/APIApplicationContact'
2881
+ description: List of contacts to add to the application
2882
+ removeContacts:
2883
+ type: array
2884
+ items:
2885
+ $ref: '#/components/schemas/APIApplicationContact'
2886
+ description: List of contacts to remove from the application
2887
+ description: List of contacts to add and remove
2888
+ APIEditApplicationContactsResponse:
2889
+ title: APIEditApplicationContactsResponse
2890
+ type: object
2891
+ properties:
2892
+ applicationId:
2893
+ type: integer
2894
+ description: Application revision id
2895
+ format: int32
2896
+ contacts:
2897
+ type: array
2898
+ items:
2899
+ $ref: '#/components/schemas/APIApplicationContact'
2900
+ description: List of contacts
2901
+ description: Contacts assigned to an application
2902
+ APIEditApplicationCustomFieldRequest:
2903
+ title: APIEditApplicationCustomFieldRequest
2904
+ type: object
2905
+ properties:
2906
+ clearCustomFields:
2907
+ type: array
2908
+ items:
2909
+ type: string
2910
+ description: List of custom field names to clear in the application
2911
+ setCustomFields:
2912
+ type: array
2913
+ items:
2914
+ $ref: '#/components/schemas/APICustomFieldRequest'
2915
+ description: List of custom fields to set in the application
2916
+ description: List of custom fields to set and clear
2917
+ APIEditApplicationCustomFieldResponse:
2918
+ title: APIEditApplicationCustomFieldResponse
2919
+ type: object
2920
+ properties:
2921
+ applicationId:
2922
+ type: integer
2923
+ description: Application revision id
2924
+ format: int32
2925
+ customFields:
2926
+ type: array
2927
+ items:
2928
+ $ref: '#/components/schemas/APICustomFieldRequest'
2929
+ description: List of custom fields values
2930
+ description: List of custom fields values in an application
2931
+ APIEditApplicationLabelsRequest:
2932
+ title: APIEditApplicationLabelsRequest
2933
+ type: object
2934
+ properties:
2935
+ addLabels:
2936
+ type: array
2937
+ items:
2938
+ type: string
2939
+ description: List of tags to add to the application
2940
+ removeLabels:
2941
+ type: array
2942
+ items:
2943
+ type: string
2944
+ description: List of tags to remove from the application
2945
+ description: List of tags to add and remove from an application
2946
+ APIEditApplicationLabelsResponse:
2947
+ title: APIEditApplicationLabelsResponse
2948
+ type: object
2949
+ properties:
2950
+ applicationId:
2951
+ type: integer
2952
+ description: Application revision id
2953
+ format: int32
2954
+ labels:
2955
+ type: array
2956
+ items:
2957
+ type: string
2958
+ description: Current tags
2959
+ description: List of tags in an application
2960
+ APIEditEndpointLabelsRequest:
2961
+ title: APIEditEndpointLabelsRequest
2962
+ type: object
2963
+ properties:
2964
+ labels:
2965
+ type: array
2966
+ items:
2967
+ type: string
2968
+ description: List of new network object tags
2969
+ description: List of new network object tags to update
2970
+ APIEditEndpointRequest:
2971
+ title: APIEditEndpointRequest
2972
+ type: object
2973
+ properties:
2974
+ addMembers:
2975
+ type: array
2976
+ items:
2977
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
2978
+ description: Group members to add. Only existing objects can be added
2979
+ addTags:
2980
+ type: array
2981
+ items:
2982
+ type: string
2983
+ description: Object tags to add. You can either add existing tags or create new ones
2984
+ clearCustomFields:
2985
+ type: array
2986
+ items:
2987
+ type: string
2988
+ description: List of custom fields to clear
2989
+ content:
2990
+ type: string
2991
+ description: New object content. The content must match the object type
2992
+ name:
2993
+ type: string
2994
+ description: New object name
2995
+ removeMembers:
2996
+ type: array
2997
+ items:
2998
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
2999
+ description: Group members to remove
3000
+ removeTags:
3001
+ type: array
3002
+ items:
3003
+ type: string
3004
+ description: Object tags to remove
3005
+ setCustomFields:
3006
+ type: array
3007
+ items:
3008
+ $ref: '#/components/schemas/APICustomFieldRequest'
3009
+ description: List of custom field values to set
3010
+ description: Network object data
3011
+ APIEditFlowRequest:
3012
+ title: APIEditFlowRequest
3013
+ type: object
3014
+ properties:
3015
+ addDestinations:
3016
+ type: array
3017
+ items:
3018
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
3019
+ description: Network objects to add as destinations
3020
+ addNetworkApplications:
3021
+ type: array
3022
+ items:
3023
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
3024
+ description: Network applications to add
3025
+ addNetworkUsers:
3026
+ type: array
3027
+ items:
3028
+ type: string
3029
+ description: Network users to add
3030
+ addServices:
3031
+ type: array
3032
+ items:
3033
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
3034
+ description: Network services to add
3035
+ addSources:
3036
+ type: array
3037
+ items:
3038
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
3039
+ description: Network objects to add as sources
3040
+ clearCustomFields:
3041
+ type: array
3042
+ items:
3043
+ type: string
3044
+ description: Custom fields to clear
3045
+ comment:
3046
+ type: string
3047
+ description: New comment
3048
+ flowID:
3049
+ type: integer
3050
+ description: Flow id
3051
+ format: int32
3052
+ name:
3053
+ type: string
3054
+ description: New flow name
3055
+ removeDestinations:
3056
+ type: array
3057
+ items:
3058
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
3059
+ description: Network objects to remove from the destinations
3060
+ removeNetworkApplications:
3061
+ type: array
3062
+ items:
3063
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
3064
+ description: Network applications to remove
3065
+ removeNetworkUsers:
3066
+ type: array
3067
+ items:
3068
+ type: string
3069
+ description: Network users to remove
3070
+ removeServices:
3071
+ type: array
3072
+ items:
3073
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
3074
+ description: Network services to remove
3075
+ removeSources:
3076
+ type: array
3077
+ items:
3078
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
3079
+ description: Network objects to remove from the sources
3080
+ setCustomFields:
3081
+ type: array
3082
+ items:
3083
+ $ref: '#/components/schemas/APICustomFieldRequest'
3084
+ description: Custom fields values to set
3085
+ description: Flow data
3086
+ APIEditNetworkServiceRequest:
3087
+ title: APIEditNetworkServiceRequest
3088
+ type: object
3089
+ properties:
3090
+ addContent:
3091
+ type: array
3092
+ items:
3093
+ $ref: '#/components/schemas/APINetworkServiceContent'
3094
+ description: List of service items to add
3095
+ clearCustomFields:
3096
+ type: array
3097
+ items:
3098
+ type: string
3099
+ description: List of custom field names to clear
3100
+ name:
3101
+ type: string
3102
+ description: New service name
3103
+ removeContent:
3104
+ type: array
3105
+ items:
3106
+ $ref: '#/components/schemas/APINetworkServiceContent'
3107
+ description: List of service items to remove
3108
+ setCustomFields:
3109
+ type: array
3110
+ items:
3111
+ $ref: '#/components/schemas/APICustomFieldRequest'
3112
+ description: List of custom field values
3113
+ description: Network service data
3114
+ APIEditedEndpoint:
3115
+ title: APIEditedEndpoint
3116
+ type: object
3117
+ properties:
3118
+ changeRequest:
3119
+ $ref: '#/components/schemas/ChangeRequest'
3120
+ networkObject:
3121
+ $ref: '#/components/schemas/NetworkObject'
3122
+ description: Edit network object results
3123
+ APIEntityApplicationPermission:
3124
+ title: APIEntityApplicationPermission
3125
+ type: object
3126
+ properties:
3127
+ applicationID:
3128
+ type: integer
3129
+ description: Application revision id
3130
+ format: int32
3131
+ name:
3132
+ type: string
3133
+ description: Permission name
3134
+ permission:
3135
+ $ref: '#/components/schemas/Permission'
3136
+ description: Application permission
3137
+ APIFlow:
3138
+ title: APIFlow
3139
+ type: object
3140
+ properties:
3141
+ comment:
3142
+ type: string
3143
+ description: Flow comments
3144
+ connectivityStatus:
3145
+ type: string
3146
+ description: Flow connectivity status
3147
+ createdDate:
3148
+ $ref: '#/components/schemas/Calendar'
3149
+ customFields:
3150
+ type: array
3151
+ items:
3152
+ $ref: '#/components/schemas/APIProperty'
3153
+ description: List of custom field values
3154
+ destinations:
3155
+ type: array
3156
+ items:
3157
+ $ref: '#/components/schemas/APINetworkObject'
3158
+ description: List of network objects used as destinations
3159
+ flowFlowID:
3160
+ type: integer
3161
+ description: Flow Flow id
3162
+ format: int32
3163
+ flowID:
3164
+ type: integer
3165
+ description: Flow id
3166
+ format: int32
3167
+ flowType:
3168
+ $ref: '#/components/schemas/FlowType'
3169
+ lastUpdateDate:
3170
+ $ref: '#/components/schemas/Calendar'
3171
+ name:
3172
+ type: string
3173
+ description: Flow name
3174
+ networkApplications:
3175
+ type: array
3176
+ items:
3177
+ $ref: '#/components/schemas/APINetworkApplication'
3178
+ description: List of network applications
3179
+ networkUsers:
3180
+ type: array
3181
+ items:
3182
+ $ref: '#/components/schemas/RestNetworkUser'
3183
+ description: List of network users
3184
+ risks:
3185
+ type: array
3186
+ items:
3187
+ $ref: '#/components/schemas/RestRisk'
3188
+ description: List of risks
3189
+ services:
3190
+ type: array
3191
+ items:
3192
+ $ref: '#/components/schemas/APINetworkService'
3193
+ description: List of network services
3194
+ sharedFlowID:
3195
+ type: integer
3196
+ description: Instance flow shared flow ID
3197
+ format: int32
3198
+ sources:
3199
+ type: array
3200
+ items:
3201
+ $ref: '#/components/schemas/APINetworkObject'
3202
+ description: List of network objects used as sources
3203
+ subscribedApplication:
3204
+ type: string
3205
+ description: Subscribed flow application name
3206
+ description: Application flow data
3207
+ APIFlowConnectivity:
3208
+ title: APIFlowConnectivity
3209
+ type: object
3210
+ properties:
3211
+ flowId:
3212
+ type: integer
3213
+ description: Flow id
3214
+ format: int32
3215
+ queryLink:
3216
+ type: string
3217
+ description: Connectivity query link
3218
+ relevantDevices:
3219
+ type: array
3220
+ items:
3221
+ type: string
3222
+ description: List of devices containing flow objects
3223
+ status:
3224
+ type: string
3225
+ description: Connectivity status
3226
+ description: Single flow connectivity status
3227
+ APIFlowNetworkEntityRequest:
3228
+ title: APIFlowNetworkEntityRequest
3229
+ type: object
3230
+ properties:
3231
+ device:
3232
+ type: string
3233
+ description: Network entity device
3234
+ name:
3235
+ type: string
3236
+ description: Network entity name
3237
+ objectID:
3238
+ type: integer
3239
+ description: Network entity ID
3240
+ format: int32
3241
+ description: Network entity (object or service) identification
3242
+ APIFlowRequest:
3243
+ title: APIFlowRequest
3244
+ allOf:
3245
+ - $ref: '#/components/schemas/APIAbstractFlowRequest'
3246
+ - type: object
3247
+ properties:
3248
+ comment:
3249
+ type: string
3250
+ description: Flow comments
3251
+ custom_fields:
3252
+ type: array
3253
+ items:
3254
+ $ref: '#/components/schemas/APICustomFieldRequest'
3255
+ description: List of flow custom field values
3256
+ destinations:
3257
+ type: array
3258
+ items:
3259
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
3260
+ description: List of network objects used as destinations
3261
+ name:
3262
+ type: string
3263
+ description: Flow name
3264
+ network_applications:
3265
+ type: array
3266
+ items:
3267
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
3268
+ description: List of network applications
3269
+ services:
3270
+ type: array
3271
+ items:
3272
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
3273
+ description: List of network services
3274
+ sources:
3275
+ type: array
3276
+ items:
3277
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
3278
+ description: List of network objects used as sources
3279
+ type:
3280
+ $ref: '#/components/schemas/Type'
3281
+ users:
3282
+ type: array
3283
+ items:
3284
+ type: string
3285
+ description: List of network users
3286
+ description: Application flow data
3287
+ APIGlobalPermission:
3288
+ title: APIGlobalPermission
3289
+ type: object
3290
+ properties:
3291
+ allowed:
3292
+ type: boolean
3293
+ description: Is permission allowed
3294
+ name:
3295
+ type: string
3296
+ description: Permission name
3297
+ description: Global permission
3298
+ APIGlobalPermissionsChange:
3299
+ title: APIGlobalPermissionsChange
3300
+ type: object
3301
+ properties:
3302
+ add:
3303
+ type: array
3304
+ items:
3305
+ type: string
3306
+ description: Permission names to add
3307
+ remove:
3308
+ type: array
3309
+ items:
3310
+ type: string
3311
+ description: Permission names to remove
3312
+ description: Permissions change data
3313
+ APILabel:
3314
+ title: APILabel
3315
+ type: object
3316
+ properties:
3317
+ name:
3318
+ type: string
3319
+ APILabelsRequest:
3320
+ title: APILabelsRequest
3321
+ type: object
3322
+ properties:
3323
+ name:
3324
+ type: string
3325
+ description: Tag name
3326
+ APINetworkApplication:
3327
+ title: APINetworkApplication
3328
+ type: object
3329
+ properties:
3330
+ createdDate:
3331
+ $ref: '#/components/schemas/Calendar'
3332
+ defaultServices:
3333
+ type: array
3334
+ items:
3335
+ type: string
3336
+ description: ''
3337
+ devices:
3338
+ type: array
3339
+ items:
3340
+ type: string
3341
+ description: ''
3342
+ lastUpdateDate:
3343
+ $ref: '#/components/schemas/Calendar'
3344
+ members:
3345
+ type: array
3346
+ items:
3347
+ $ref: '#/components/schemas/RestNamedObject'
3348
+ description: ''
3349
+ name:
3350
+ type: string
3351
+ origin:
3352
+ type: string
3353
+ revisionID:
3354
+ type: integer
3355
+ format: int32
3356
+ APINetworkObject:
3357
+ title: APINetworkObject
3358
+ type: object
3359
+ properties:
3360
+ createdDate:
3361
+ $ref: '#/components/schemas/Calendar'
3362
+ customFields:
3363
+ type: array
3364
+ items:
3365
+ $ref: '#/components/schemas/APIProperty'
3366
+ description: List of custom field values
3367
+ devices:
3368
+ type: array
3369
+ items:
3370
+ type: string
3371
+ description: List of devices containing the object
3372
+ ipAddresses:
3373
+ type: array
3374
+ items:
3375
+ type: string
3376
+ description: List of IP addresses
3377
+ lastUpdateDate:
3378
+ $ref: '#/components/schemas/Calendar'
3379
+ members:
3380
+ type: array
3381
+ items:
3382
+ $ref: '#/components/schemas/RestNamedObject'
3383
+ description: List of group members
3384
+ name:
3385
+ type: string
3386
+ description: Object name
3387
+ objectID:
3388
+ type: integer
3389
+ description: Object id of the first revision
3390
+ format: int32
3391
+ objectType:
3392
+ type: string
3393
+ description: Object type
3394
+ origin:
3395
+ type: string
3396
+ description: Object origin
3397
+ revisionID:
3398
+ type: integer
3399
+ description: Object revision id
3400
+ format: int32
3401
+ revisionStatus:
3402
+ type: string
3403
+ description: Object revision status
3404
+ tags:
3405
+ type: object
3406
+ additionalProperties:
3407
+ type: object
3408
+ description: Network object tags by tag type
3409
+ vulnerabilityScore:
3410
+ type: integer
3411
+ description: Vulnerability score
3412
+ format: int32
3413
+ description: Network object data
3414
+ APINetworkObjectContent:
3415
+ title: APINetworkObjectContent
3416
+ type: object
3417
+ properties:
3418
+ customFields:
3419
+ type: array
3420
+ items:
3421
+ $ref: '#/components/schemas/APICustomFieldRequest'
3422
+ description: List of network object custom field values
3423
+ name:
3424
+ type: string
3425
+ description: Network object name
3426
+ objectContainerLevel:
3427
+ type: string
3428
+ selectedDevice:
3429
+ type: array
3430
+ items:
3431
+ type: integer
3432
+ format: int32
3433
+ description: List of network object selected device
3434
+ subject:
3435
+ type: string
3436
+ tags:
3437
+ type: array
3438
+ items:
3439
+ $ref: '#/components/schemas/APILabelsRequest'
3440
+ description: Network object tags
3441
+ type:
3442
+ $ref: '#/components/schemas/Type3'
3443
+ description: Network object content
3444
+ APINetworkObjectContentAbstract:
3445
+ title: APINetworkObjectContentAbstract
3446
+ type: object
3447
+ properties:
3448
+ customFields:
3449
+ type: array
3450
+ items:
3451
+ $ref: '#/components/schemas/APICustomFieldRequest'
3452
+ description: List of network object custom field values
3453
+ name:
3454
+ type: string
3455
+ description: Name
3456
+ objectContainerLevel:
3457
+ type: string
3458
+ selectedDevice:
3459
+ type: array
3460
+ items:
3461
+ type: integer
3462
+ format: int32
3463
+ description: List of network object selected device
3464
+ subject:
3465
+ type: string
3466
+ tags:
3467
+ type: array
3468
+ items:
3469
+ $ref: '#/components/schemas/APILabelsRequest'
3470
+ description: Tags
3471
+ type:
3472
+ $ref: '#/components/schemas/Type4'
3473
+ description: New abstract network object
3474
+ APINetworkObjectContentGroup:
3475
+ title: APINetworkObjectContentGroup
3476
+ type: object
3477
+ properties:
3478
+ content:
3479
+ type: array
3480
+ items:
3481
+ $ref: '#/components/schemas/APINetworkObjectContent'
3482
+ description: List of contents
3483
+ customFields:
3484
+ type: array
3485
+ items:
3486
+ $ref: '#/components/schemas/APICustomFieldRequest'
3487
+ description: List of network object custom field values
3488
+ name:
3489
+ type: string
3490
+ description: Name
3491
+ objectContainerLevel:
3492
+ type: string
3493
+ description: Object container level
3494
+ selectedDevice:
3495
+ type: array
3496
+ items:
3497
+ type: integer
3498
+ format: int32
3499
+ description: List of network object selected device
3500
+ selectedDevicesIds:
3501
+ type: array
3502
+ items:
3503
+ type: integer
3504
+ format: int32
3505
+ description: Selected devices Ids
3506
+ subject:
3507
+ type: string
3508
+ description: Subject
3509
+ tags:
3510
+ type: array
3511
+ items:
3512
+ $ref: '#/components/schemas/APILabelsRequest'
3513
+ description: Tags
3514
+ type:
3515
+ $ref: '#/components/schemas/Type4'
3516
+ description: New network object group
3517
+ APINetworkObjectContentHostRange:
3518
+ title: APINetworkObjectContentHostRange
3519
+ type: object
3520
+ properties:
3521
+ content:
3522
+ type: string
3523
+ description: Content
3524
+ customFields:
3525
+ type: array
3526
+ items:
3527
+ $ref: '#/components/schemas/APICustomFieldRequest'
3528
+ description: List of network object custom field values
3529
+ custom_fields:
3530
+ type: array
3531
+ items:
3532
+ $ref: '#/components/schemas/APICustomFieldRequest'
3533
+ description: ''
3534
+ name:
3535
+ type: string
3536
+ description: Name
3537
+ objectContainerLevel:
3538
+ type: string
3539
+ description: Object container level
3540
+ selectedDevice:
3541
+ type: array
3542
+ items:
3543
+ type: integer
3544
+ format: int32
3545
+ description: List of network object selected device
3546
+ selectedDevicesIds:
3547
+ type: array
3548
+ items:
3549
+ type: integer
3550
+ format: int32
3551
+ description: Selected devices Ids
3552
+ subject:
3553
+ type: string
3554
+ description: Subject
3555
+ tags:
3556
+ type: array
3557
+ items:
3558
+ $ref: '#/components/schemas/APILabelsRequest'
3559
+ description: Tags
3560
+ type:
3561
+ $ref: '#/components/schemas/Type4'
3562
+ description: Network object content
3563
+ APINetworkService:
3564
+ title: APINetworkService
3565
+ type: object
3566
+ properties:
3567
+ createdDate:
3568
+ $ref: '#/components/schemas/Calendar'
3569
+ customFields:
3570
+ type: array
3571
+ items:
3572
+ $ref: '#/components/schemas/APIProperty'
3573
+ description: List of custom field values
3574
+ devices:
3575
+ type: array
3576
+ items:
3577
+ type: string
3578
+ description: List of devices that contain the service
3579
+ lastUpdateDate:
3580
+ $ref: '#/components/schemas/Calendar'
3581
+ name:
3582
+ type: string
3583
+ description: Service name
3584
+ origin:
3585
+ type: string
3586
+ description: Service origin
3587
+ revisionID:
3588
+ type: integer
3589
+ description: Revision id
3590
+ format: int32
3591
+ revisionStatus:
3592
+ type: string
3593
+ description: Revision status
3594
+ serviceID:
3595
+ type: integer
3596
+ description: First revision id
3597
+ format: int32
3598
+ services:
3599
+ type: array
3600
+ items:
3601
+ type: string
3602
+ description: List of service item names
3603
+ description: Network Service
3604
+ APINetworkServiceContent:
3605
+ title: APINetworkServiceContent
3606
+ type: object
3607
+ properties:
3608
+ port:
3609
+ type: string
3610
+ description: Service port number
3611
+ protocol:
3612
+ type: string
3613
+ description: Service protocol name
3614
+ description: Network service item data
3615
+ APINetworkServiceRequest:
3616
+ title: APINetworkServiceRequest
3617
+ type: object
3618
+ properties:
3619
+ content:
3620
+ type: array
3621
+ items:
3622
+ $ref: '#/components/schemas/APINetworkServiceContent'
3623
+ description: List of service items
3624
+ custom_fields:
3625
+ type: array
3626
+ items:
3627
+ $ref: '#/components/schemas/APICustomFieldRequest'
3628
+ description: List of custom field values
3629
+ name:
3630
+ type: string
3631
+ description: Network service name
3632
+ description: Network service content
3633
+ APINewRole:
3634
+ title: APINewRole
3635
+ type: object
3636
+ properties:
3637
+ authorizedApplications:
3638
+ type: array
3639
+ items:
3640
+ $ref: '#/components/schemas/APIApplicationPermission'
3641
+ description: List of allowed application permissions
3642
+ authorizedViewsAndActions:
3643
+ type: array
3644
+ items:
3645
+ type: string
3646
+ description: List of allowed global permissions
3647
+ description:
3648
+ type: string
3649
+ description: Role description
3650
+ enabled:
3651
+ type: boolean
3652
+ description: Is enabled
3653
+ ldapGroupDN:
3654
+ type: string
3655
+ description: LDAP group DN
3656
+ name:
3657
+ type: string
3658
+ description: Role name
3659
+ users:
3660
+ type: array
3661
+ items:
3662
+ type: string
3663
+ description: List of user names assigned to the role
3664
+ description: New role content
3665
+ APIPermissionChanges:
3666
+ title: APIPermissionChanges
3667
+ type: object
3668
+ properties:
3669
+ authorizedApplicationsChanges:
3670
+ $ref: '#/components/schemas/AuthorizedApplicationsChanges'
3671
+ authorizedViewsAndActionChanges:
3672
+ $ref: '#/components/schemas/AuthorizedViewsAndActionChanges'
3673
+ description: Permission content
3674
+ APIProperty:
3675
+ title: APIProperty
3676
+ type: object
3677
+ properties:
3678
+ link:
3679
+ type: string
3680
+ description: Link field URL
3681
+ name:
3682
+ type: string
3683
+ description: Custom field name
3684
+ value:
3685
+ type: string
3686
+ description: Custom field value
3687
+ APIReplaceAbstractObjectRequest:
3688
+ title: APIReplaceAbstractObjectRequest
3689
+ type: object
3690
+ properties:
3691
+ replaceInApplications:
3692
+ type: array
3693
+ items:
3694
+ type: string
3695
+ description: List of names of applications in which to replace the abstract object. If empty list, replace in all applications
3696
+ replaceWith:
3697
+ $ref: '#/components/schemas/ReplaceWith'
3698
+ description: Replace abstract object data
3699
+ APIReplaceAbstractObjectResponse:
3700
+ title: APIReplaceAbstractObjectResponse
3701
+ type: object
3702
+ properties:
3703
+ changeRequestId:
3704
+ type: integer
3705
+ description: FireFlow change request id
3706
+ format: int32
3707
+ replacedInApplications:
3708
+ type: array
3709
+ items:
3710
+ type: integer
3711
+ format: int32
3712
+ description: List of application id where the object was replaced
3713
+ description: Replace abstract object action results
3714
+ APIRoleEntityPermissions:
3715
+ title: APIRoleEntityPermissions
3716
+ type: object
3717
+ properties:
3718
+ authorizedApplications:
3719
+ type: array
3720
+ items:
3721
+ $ref: '#/components/schemas/APIEntityApplicationPermission'
3722
+ description: List of allowed application permissions
3723
+ authorizedViewsAndActions:
3724
+ type: array
3725
+ items:
3726
+ $ref: '#/components/schemas/APIGlobalPermission'
3727
+ description: List of allowed global permissions
3728
+ enabled:
3729
+ type: boolean
3730
+ description: Is enabled
3731
+ name:
3732
+ type: string
3733
+ description: Permission name
3734
+ roleUsers:
3735
+ type: array
3736
+ items:
3737
+ type: string
3738
+ description: List of user names assigned to the role
3739
+ description: Role permissions
3740
+ APIRolePermissionChanges:
3741
+ title: APIRolePermissionChanges
3742
+ type: object
3743
+ properties:
3744
+ authorizedApplicationsChanges:
3745
+ $ref: '#/components/schemas/AuthorizedApplicationsChanges'
3746
+ authorizedViewsAndActionChanges:
3747
+ $ref: '#/components/schemas/AuthorizedViewsAndActionChanges'
3748
+ users:
3749
+ $ref: '#/components/schemas/Users'
3750
+ description: Role permission content
3751
+ APIRoleUsersChange:
3752
+ title: APIRoleUsersChange
3753
+ type: object
3754
+ properties:
3755
+ add:
3756
+ type: array
3757
+ items:
3758
+ type: string
3759
+ description: List of user names to add to the role
3760
+ remove:
3761
+ type: array
3762
+ items:
3763
+ type: string
3764
+ description: List of user names to remove from the role
3765
+ description: Role users change
3766
+ APISubscribedFlowContent:
3767
+ title: APISubscribedFlowContent
3768
+ type: object
3769
+ properties:
3770
+ comment:
3771
+ type: string
3772
+ description: Flow comments
3773
+ custom_fields:
3774
+ type: array
3775
+ items:
3776
+ $ref: '#/components/schemas/APICustomFieldRequest'
3777
+ description: List of flow custom field values
3778
+ placeholder_network_object:
3779
+ type: array
3780
+ items:
3781
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
3782
+ description: List of network entity placeholders to be assigned
3783
+ shared_flow_name:
3784
+ type: string
3785
+ description: Shared flow name
3786
+ users:
3787
+ type: array
3788
+ items:
3789
+ type: string
3790
+ description: List of network users
3791
+ description: Subscribed flow data
3792
+ APISubscribedFlowRequest:
3793
+ title: APISubscribedFlowRequest
3794
+ allOf:
3795
+ - $ref: '#/components/schemas/APIAbstractFlowRequest'
3796
+ - type: object
3797
+ properties:
3798
+ shared_application_name:
3799
+ type: string
3800
+ description: Shared application name
3801
+ subscribed_flows:
3802
+ type: array
3803
+ items:
3804
+ $ref: '#/components/schemas/APISubscribedFlowContent'
3805
+ description: >-
3806
+ List of shared flows subscribed by the application
3807
+
3808
+ Usage example:
3809
+
3810
+ {
3811
+
3812
+  "type": "SUBSCRIBED",
3813
+
3814
+  "shared_application_name": "string",
3815
+
3816
+  "subscribed_flows": [
3817
+
3818
+   {
3819
+
3820
+    "shared_flow_name": "string",
3821
+
3822
+    "placeholder_network_object": [
3823
+
3824
+     {
3825
+
3826
+     "name": "string",
3827
+
3828
+     "device" : "string"
3829
+
3830
+     }
3831
+
3832
+    ],
3833
+
3834
+    "comment": "string",
3835
+
3836
+    "custom_fields": [
3837
+
3838
+     {
3839
+
3840
+     "name": "string",
3841
+
3842
+     "value": "string"
3843
+
3844
+     }
3845
+
3846
+    ]
3847
+
3848
+   }
3849
+
3850
+  ]
3851
+
3852
+ }
3853
+ type:
3854
+ $ref: '#/components/schemas/Type'
3855
+ description: Subscribed flow
3856
+ APIUserEntityPermissions:
3857
+ title: APIUserEntityPermissions
3858
+ type: object
3859
+ properties:
3860
+ authorizedApplications:
3861
+ type: array
3862
+ items:
3863
+ $ref: '#/components/schemas/APIEntityApplicationPermission'
3864
+ description: List of allowed application permissions
3865
+ authorizedViewsAndActions:
3866
+ type: array
3867
+ items:
3868
+ $ref: '#/components/schemas/APIGlobalPermission'
3869
+ description: List of allowed global permissions
3870
+ fullName:
3871
+ type: string
3872
+ description: User full name
3873
+ inheritedAuthorizedApplications:
3874
+ type: array
3875
+ items:
3876
+ $ref: '#/components/schemas/APIEntityApplicationPermission'
3877
+ description: List of inherited application permissions
3878
+ name:
3879
+ type: string
3880
+ description: Permission name
3881
+ privileged:
3882
+ type: boolean
3883
+ roles:
3884
+ type: array
3885
+ items:
3886
+ type: string
3887
+ description: List of role names assigned to the user
3888
+ description: User permissions
3889
+ Calendar:
3890
+ title: Calendar
3891
+ type: object
3892
+ properties:
3893
+ calendarType:
3894
+ type: string
3895
+ firstDayOfWeek:
3896
+ type: integer
3897
+ format: int32
3898
+ lenient:
3899
+ type: boolean
3900
+ minimalDaysInFirstWeek:
3901
+ type: integer
3902
+ format: int32
3903
+ time:
3904
+ type: string
3905
+ format: date-time
3906
+ timeInMillis:
3907
+ type: integer
3908
+ format: int64
3909
+ timeZone:
3910
+ $ref: '#/components/schemas/TimeZone'
3911
+ weekDateSupported:
3912
+ type: boolean
3913
+ weekYear:
3914
+ type: integer
3915
+ format: int32
3916
+ weeksInWeekYear:
3917
+ type: integer
3918
+ format: int32
3919
+ PciApplicationVulnerabilityResponse:
3920
+ title: PciApplicationVulnerabilityResponse
3921
+ type: object
3922
+ properties:
3923
+ application_id:
3924
+ type: integer
3925
+ description: Application revision id
3926
+ format: int32
3927
+ application_name:
3928
+ type: string
3929
+ description: Application name
3930
+ application_severity:
3931
+ type: string
3932
+ description: Application vulnerability severity
3933
+ application_vulnerability_score:
3934
+ type: integer
3935
+ description: Application vulnerability score
3936
+ format: int32
3937
+ unscanned_pci_servers:
3938
+ type: integer
3939
+ description: Unscanned servers in PCI zone
3940
+ format: int32
3941
+ unscanned_servers:
3942
+ type: integer
3943
+ description: Unscanned servers
3944
+ format: int32
3945
+ description: Vulnerability scores for applications in PCI zone
3946
+ ResponseEntity:
3947
+ title: ResponseEntity
3948
+ type: object
3949
+ properties:
3950
+ body:
3951
+ type: object
3952
+ statusCode:
3953
+ $ref: '#/components/schemas/StatusCode'
3954
+ statusCodeValue:
3955
+ type: integer
3956
+ format: int32
3957
+ RestApplicationConnectivity:
3958
+ title: RestApplicationConnectivity
3959
+ type: object
3960
+ properties:
3961
+ flows:
3962
+ type: array
3963
+ items:
3964
+ $ref: '#/components/schemas/APIFlowConnectivity'
3965
+ description: List of connectivity status by flow
3966
+ status:
3967
+ type: string
3968
+ description: Connectivity status for application flow
3969
+ description: Connectivity status for application flows
3970
+ RestApplicationPersonRole:
3971
+ title: RestApplicationPersonRole
3972
+ type: object
3973
+ properties:
3974
+ email:
3975
+ type: string
3976
+ description: Contact e-mail address
3977
+ name:
3978
+ type: string
3979
+ description: Contact name
3980
+ phone:
3981
+ type: string
3982
+ description: Contact phone number
3983
+ role:
3984
+ type: string
3985
+ description: Contact role in the application
3986
+ description: Application contact data
3987
+ RestApplicationVulnerability:
3988
+ title: RestApplicationVulnerability
3989
+ type: object
3990
+ properties:
3991
+ findings:
3992
+ type: array
3993
+ items:
3994
+ $ref: '#/components/schemas/RestObjectVulnerability'
3995
+ description: List of vulnerabilities found in the application
3996
+ missingInformation:
3997
+ type: array
3998
+ items:
3999
+ $ref: '#/components/schemas/RestNamedObject'
4000
+ description: List of user names with application view permissions
4001
+ description: Application vulnerability information
4002
+ RestBaseApplicationRevision:
4003
+ title: RestBaseApplicationRevision
4004
+ type: object
4005
+ properties:
4006
+ applicationRevisionID:
4007
+ type: integer
4008
+ description: Application Revision ID
4009
+ format: int32
4010
+ createdDate:
4011
+ $ref: '#/components/schemas/Calendar'
4012
+ revisionID:
4013
+ type: integer
4014
+ description: Application revision id
4015
+ format: int32
4016
+ revisionStatus:
4017
+ type: string
4018
+ description: Application revision status
4019
+ description: Application revision information
4020
+ RestChangeApplicationResponse:
4021
+ title: RestChangeApplicationResponse
4022
+ type: object
4023
+ properties:
4024
+ application:
4025
+ $ref: '#/components/schemas/Application'
4026
+ changeRequest:
4027
+ $ref: '#/components/schemas/ChangeRequest'
4028
+ description: Application data after change
4029
+ RestChangeRequest:
4030
+ title: RestChangeRequest
4031
+ type: object
4032
+ properties:
4033
+ id:
4034
+ type: integer
4035
+ description: Change request id
4036
+ format: int32
4037
+ openedDate:
4038
+ $ref: '#/components/schemas/Calendar'
4039
+ requestor:
4040
+ type: string
4041
+ description: Requestor name
4042
+ status:
4043
+ type: string
4044
+ description: Change request status
4045
+ subject:
4046
+ type: string
4047
+ description: Change request subject
4048
+ description: FireFlow change request data
4049
+ RestNamedObject:
4050
+ title: RestNamedObject
4051
+ type: object
4052
+ properties:
4053
+ id:
4054
+ type: integer
4055
+ format: int32
4056
+ name:
4057
+ type: string
4058
+ RestNetworkUser:
4059
+ title: RestNetworkUser
4060
+ type: object
4061
+ properties:
4062
+ id:
4063
+ type: integer
4064
+ format: int32
4065
+ name:
4066
+ type: string
4067
+ RestObjectVulnerability:
4068
+ title: RestObjectVulnerability
4069
+ type: object
4070
+ properties:
4071
+ objectID:
4072
+ type: integer
4073
+ description: Network object id
4074
+ format: int32
4075
+ objectName:
4076
+ type: string
4077
+ description: Network object name
4078
+ vulnerabilities:
4079
+ type: array
4080
+ items:
4081
+ $ref: '#/components/schemas/RestVulnerability'
4082
+ description: List of vulnerabilities
4083
+ description: Network object vulnerability
4084
+ RestRisk:
4085
+ title: RestRisk
4086
+ type: object
4087
+ properties:
4088
+ code:
4089
+ type: string
4090
+ description: Risk code
4091
+ level:
4092
+ type: string
4093
+ description: Risk level
4094
+ profile:
4095
+ type: string
4096
+ description: Risk profile
4097
+ riskId:
4098
+ type: integer
4099
+ description: Risk id
4100
+ format: int32
4101
+ title:
4102
+ type: string
4103
+ description: Risk description
4104
+ description: Application risk information
4105
+ RestStatus:
4106
+ title: RestStatus
4107
+ type: object
4108
+ properties:
4109
+ errors:
4110
+ type: object
4111
+ message:
4112
+ type: string
4113
+ success:
4114
+ type: boolean
4115
+ RestVulnerability:
4116
+ title: RestVulnerability
4117
+ type: object
4118
+ properties:
4119
+ cvss:
4120
+ type: number
4121
+ description: Vulnerability score
4122
+ description:
4123
+ type: string
4124
+ description: Vulnerability description
4125
+ id:
4126
+ type: string
4127
+ description: Vulnerability id
4128
+ ip:
4129
+ type: string
4130
+ description: IP address
4131
+ title:
4132
+ type: string
4133
+ description: Vulnerability title
4134
+ description: Vulnerability information
4135
+ Status:
4136
+ title: Status
4137
+ type: object
4138
+ properties:
4139
+ data:
4140
+ type: object
4141
+ error:
4142
+ type: string
4143
+ files:
4144
+ type: object
4145
+ msg:
4146
+ type: string
4147
+ status:
4148
+ type: string
4149
+ success:
4150
+ type: boolean
4151
+ type:
4152
+ type: string
4153
+ TimeZone:
4154
+ title: TimeZone
4155
+ type: object
4156
+ properties:
4157
+ displayName:
4158
+ type: string
4159
+ dstsavings:
4160
+ type: integer
4161
+ format: int32
4162
+ id:
4163
+ type: string
4164
+ rawOffset:
4165
+ type: integer
4166
+ format: int32
4167
+ FlowType:
4168
+ title: FlowType
4169
+ enum:
4170
+ - APPLICATION_FLOW
4171
+ - SHARED_FLOW
4172
+ - SHARED_FLOW_INSTANCE
4173
+ - SUBSCRIBED_FLOW
4174
+ type: string
4175
+ description: Flow type
4176
+ Permission:
4177
+ title: Permission
4178
+ enum:
4179
+ - view
4180
+ - edit
4181
+ type: string
4182
+ description: Permission type
4183
+ Permission1:
4184
+ title: Permission1
4185
+ enum:
4186
+ - VIEW
4187
+ - EDIT
4188
+ type: string
4189
+ description: Permission type
4190
+ StatusCode:
4191
+ title: StatusCode
4192
+ enum:
4193
+ - 100 CONTINUE
4194
+ - 101 SWITCHING_PROTOCOLS
4195
+ - 102 PROCESSING
4196
+ - 103 CHECKPOINT
4197
+ - 200 OK
4198
+ - 201 CREATED
4199
+ - 202 ACCEPTED
4200
+ - 203 NON_AUTHORITATIVE_INFORMATION
4201
+ - 204 NO_CONTENT
4202
+ - 205 RESET_CONTENT
4203
+ - 206 PARTIAL_CONTENT
4204
+ - 207 MULTI_STATUS
4205
+ - 208 ALREADY_REPORTED
4206
+ - 226 IM_USED
4207
+ - 300 MULTIPLE_CHOICES
4208
+ - 301 MOVED_PERMANENTLY
4209
+ - 302 FOUND
4210
+ - 302 MOVED_TEMPORARILY
4211
+ - 303 SEE_OTHER
4212
+ - 304 NOT_MODIFIED
4213
+ - 305 USE_PROXY
4214
+ - 307 TEMPORARY_REDIRECT
4215
+ - 308 PERMANENT_REDIRECT
4216
+ - 400 BAD_REQUEST
4217
+ - 401 UNAUTHORIZED
4218
+ - 402 PAYMENT_REQUIRED
4219
+ - 403 FORBIDDEN
4220
+ - 404 NOT_FOUND
4221
+ - 405 METHOD_NOT_ALLOWED
4222
+ - 406 NOT_ACCEPTABLE
4223
+ - 407 PROXY_AUTHENTICATION_REQUIRED
4224
+ - 408 REQUEST_TIMEOUT
4225
+ - 409 CONFLICT
4226
+ - 410 GONE
4227
+ - 411 LENGTH_REQUIRED
4228
+ - 412 PRECONDITION_FAILED
4229
+ - 413 PAYLOAD_TOO_LARGE
4230
+ - 413 REQUEST_ENTITY_TOO_LARGE
4231
+ - 414 URI_TOO_LONG
4232
+ - 414 REQUEST_URI_TOO_LONG
4233
+ - 415 UNSUPPORTED_MEDIA_TYPE
4234
+ - 416 REQUESTED_RANGE_NOT_SATISFIABLE
4235
+ - 417 EXPECTATION_FAILED
4236
+ - 418 I_AM_A_TEAPOT
4237
+ - 419 INSUFFICIENT_SPACE_ON_RESOURCE
4238
+ - 420 METHOD_FAILURE
4239
+ - 421 DESTINATION_LOCKED
4240
+ - 422 UNPROCESSABLE_ENTITY
4241
+ - 423 LOCKED
4242
+ - 424 FAILED_DEPENDENCY
4243
+ - 425 TOO_EARLY
4244
+ - 426 UPGRADE_REQUIRED
4245
+ - 428 PRECONDITION_REQUIRED
4246
+ - 429 TOO_MANY_REQUESTS
4247
+ - 431 REQUEST_HEADER_FIELDS_TOO_LARGE
4248
+ - 451 UNAVAILABLE_FOR_LEGAL_REASONS
4249
+ - 500 INTERNAL_SERVER_ERROR
4250
+ - 501 NOT_IMPLEMENTED
4251
+ - 502 BAD_GATEWAY
4252
+ - 503 SERVICE_UNAVAILABLE
4253
+ - 504 GATEWAY_TIMEOUT
4254
+ - 505 HTTP_VERSION_NOT_SUPPORTED
4255
+ - 506 VARIANT_ALSO_NEGOTIATES
4256
+ - 507 INSUFFICIENT_STORAGE
4257
+ - 508 LOOP_DETECTED
4258
+ - 509 BANDWIDTH_LIMIT_EXCEEDED
4259
+ - 510 NOT_EXTENDED
4260
+ - 511 NETWORK_AUTHENTICATION_REQUIRED
4261
+ type: string
4262
+ Type:
4263
+ title: Type
4264
+ enum:
4265
+ - APPLICATION
4266
+ - SHARED
4267
+ - SUBSCRIBED
4268
+ type: string
4269
+ description: Flow type (flow data fields depend on the flow type. See usage example in the notes section above)
4270
+ Type1:
4271
+ title: Type1
4272
+ enum:
4273
+ - USER
4274
+ - ROLE
4275
+ type: string
4276
+ description: Permission entity type
4277
+ Type3:
4278
+ title: Type3
4279
+ enum:
4280
+ - Unknown
4281
+ - Range
4282
+ - Host
4283
+ - Network
4284
+ - Group
4285
+ - Domain
4286
+ - Gateway
4287
+ - Abstract
4288
+ type: string
4289
+ description: Network object type
4290
+ Type4:
4291
+ title: Type4
4292
+ enum:
4293
+ - Unknown
4294
+ - Range
4295
+ - Host
4296
+ - Network
4297
+ - Group
4298
+ - Domain
4299
+ - Gateway
4300
+ - Abstract
4301
+ type: string
4302
+ description: Type
4303
+ type8:
4304
+ title: type8
4305
+ enum:
4306
+ - CRITICAL_PROCESS
4307
+ - USER_DEFINED
4308
+ - PCI
4309
+ - DYNAMIC
4310
+ - SYSTEM_TAGS
4311
+ - USER_TAGS
4312
+ type: string
4313
+ type9:
4314
+ title: type9
4315
+ enum:
4316
+ - DEFAULT
4317
+ - CONTAINED
4318
+ - CONTAINING
4319
+ - EXACT
4320
+ - INTERSECT
4321
+ - NONE
4322
+ - NAME
4323
+ - OBJECT
4324
+ - DISPLAY
4325
+ type: string
4326
+ Application:
4327
+ title: Application
4328
+ type: object
4329
+ properties:
4330
+ applicationID:
4331
+ type: integer
4332
+ description: First application revision id
4333
+ format: int32
4334
+ connectivityStatus:
4335
+ type: string
4336
+ description: Application flows connectivity status
4337
+ contacts:
4338
+ type: array
4339
+ items:
4340
+ $ref: '#/components/schemas/RestApplicationPersonRole'
4341
+ description: List of application contacts
4342
+ createdDate:
4343
+ $ref: '#/components/schemas/Calendar'
4344
+ customFields:
4345
+ type: array
4346
+ items:
4347
+ $ref: '#/components/schemas/APIProperty'
4348
+ description: List of application custom field values
4349
+ expirationDate:
4350
+ $ref: '#/components/schemas/Calendar'
4351
+ labels:
4352
+ type: array
4353
+ items:
4354
+ $ref: '#/components/schemas/APILabel'
4355
+ description: List of application tags
4356
+ lastRiskCheck:
4357
+ $ref: '#/components/schemas/Calendar'
4358
+ lastUpdateDate:
4359
+ $ref: '#/components/schemas/Calendar'
4360
+ lifecyclePhase:
4361
+ type: string
4362
+ description: Application lifecycle phase
4363
+ name:
4364
+ type: string
4365
+ description: Application name
4366
+ revisionID:
4367
+ type: integer
4368
+ description: Application revision id
4369
+ format: int32
4370
+ revisionStatus:
4371
+ type: string
4372
+ description: Application revision status
4373
+ riskScore:
4374
+ type: integer
4375
+ description: Risk score for application flows
4376
+ format: int32
4377
+ vulnerabilityScore:
4378
+ type: integer
4379
+ description: Vulnerability score for application flows
4380
+ format: int32
4381
+ ApplicationsApplyRequest:
4382
+ title: ApplicationsApplyRequest
4383
+ type: object
4384
+ properties:
4385
+ selectedFlowsIds:
4386
+ type: array
4387
+ items:
4388
+ type: integer
4389
+ format: int32
4390
+ description: ''
4391
+ ApplicationsContactsRequest:
4392
+ title: ApplicationsContactsRequest
4393
+ type: object
4394
+ properties:
4395
+ addContacts:
4396
+ type: array
4397
+ items:
4398
+ $ref: '#/components/schemas/APIApplicationContact'
4399
+ description: List of contacts to add to the application
4400
+ removeContacts:
4401
+ type: array
4402
+ items:
4403
+ $ref: '#/components/schemas/APIApplicationContact'
4404
+ description: List of contacts to remove from the application
4405
+ ApplicationsCustomFieldsRequest:
4406
+ title: ApplicationsCustomFieldsRequest
4407
+ type: object
4408
+ properties:
4409
+ clearCustomFields:
4410
+ type: array
4411
+ items:
4412
+ type: string
4413
+ description: List of custom field names to clear in the application
4414
+ setCustomFields:
4415
+ type: array
4416
+ items:
4417
+ $ref: '#/components/schemas/APICustomFieldRequest'
4418
+ description: List of custom fields to set in the application
4419
+ ApplicationsLabelsRequest:
4420
+ title: ApplicationsLabelsRequest
4421
+ type: object
4422
+ properties:
4423
+ addLabels:
4424
+ type: array
4425
+ items:
4426
+ type: string
4427
+ description: List of tags to add to the application
4428
+ removeLabels:
4429
+ type: array
4430
+ items:
4431
+ type: string
4432
+ description: List of tags to remove from the application
4433
+ ApplicationsNewRequest:
4434
+ title: ApplicationsNewRequest
4435
+ type: object
4436
+ properties:
4437
+ contacts:
4438
+ type: array
4439
+ items:
4440
+ $ref: '#/components/schemas/APIApplicationContact'
4441
+ description: List of contacts and roles
4442
+ custom_fields:
4443
+ type: array
4444
+ items:
4445
+ $ref: '#/components/schemas/APICustomFieldRequest'
4446
+ description: List of custom field values
4447
+ flows:
4448
+ type: array
4449
+ items:
4450
+ $ref: '#/components/schemas/APIAbstractFlowRequest'
4451
+ description: List of flows
4452
+ labels:
4453
+ type: array
4454
+ items:
4455
+ type: string
4456
+ description: List of tags
4457
+ name:
4458
+ type: string
4459
+ description: Application name
4460
+ permissions:
4461
+ type: array
4462
+ items:
4463
+ $ref: '#/components/schemas/APIApplicationPermissionDefinition'
4464
+ description: List of permissions
4465
+ AuthorizedApplicationsChanges:
4466
+ title: AuthorizedApplicationsChanges
4467
+ type: object
4468
+ properties:
4469
+ add:
4470
+ type: array
4471
+ items:
4472
+ $ref: '#/components/schemas/APIApplicationPermission'
4473
+ description: Application permissions to add
4474
+ remove:
4475
+ type: array
4476
+ items:
4477
+ type: integer
4478
+ format: int32
4479
+ description: Application permissions to remove
4480
+ AuthorizedViewsAndActionChanges:
4481
+ title: AuthorizedViewsAndActionChanges
4482
+ type: object
4483
+ properties:
4484
+ add:
4485
+ type: array
4486
+ items:
4487
+ type: string
4488
+ description: Permission names to add
4489
+ remove:
4490
+ type: array
4491
+ items:
4492
+ type: string
4493
+ description: Permission names to remove
4494
+ ChangeRequest:
4495
+ title: ChangeRequest
4496
+ type: object
4497
+ properties:
4498
+ id:
4499
+ type: integer
4500
+ description: Change request id
4501
+ format: int32
4502
+ openedDate:
4503
+ $ref: '#/components/schemas/Calendar'
4504
+ requestor:
4505
+ type: string
4506
+ description: Requestor name
4507
+ status:
4508
+ type: string
4509
+ description: Change request status
4510
+ subject:
4511
+ type: string
4512
+ description: Change request subject
4513
+ Content-Type:
4514
+ title: Content-Type
4515
+ enum:
4516
+ - application/json
4517
+ type: string
4518
+ NetworkObjectsNewRequest:
4519
+ title: NetworkObjectsNewRequest
4520
+ type: object
4521
+ properties:
4522
+ customFields:
4523
+ type: array
4524
+ items:
4525
+ $ref: '#/components/schemas/APICustomFieldRequest'
4526
+ description: List of network object custom field values
4527
+ name:
4528
+ type: string
4529
+ description: Network object name
4530
+ objectContainerLevel:
4531
+ type: string
4532
+ selectedDevice:
4533
+ type: array
4534
+ items:
4535
+ type: integer
4536
+ format: int32
4537
+ description: List of network object selected device
4538
+ subject:
4539
+ type: string
4540
+ tags:
4541
+ type: array
4542
+ items:
4543
+ $ref: '#/components/schemas/APILabelsRequest'
4544
+ description: Network object tags
4545
+ type:
4546
+ $ref: '#/components/schemas/Type3'
4547
+ NetworkObjectsReplaceRequest:
4548
+ title: NetworkObjectsReplaceRequest
4549
+ type: object
4550
+ properties:
4551
+ replaceInApplications:
4552
+ type: array
4553
+ items:
4554
+ type: string
4555
+ description: List of names of applications in which to replace the abstract object. If empty list, replace in all applications
4556
+ replaceWith:
4557
+ $ref: '#/components/schemas/ReplaceWith'
4558
+ NetworkObjectsRequest:
4559
+ title: NetworkObjectsRequest
4560
+ type: object
4561
+ properties:
4562
+ addMembers:
4563
+ type: array
4564
+ items:
4565
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
4566
+ description: Group members to add. Only existing objects can be added
4567
+ addTags:
4568
+ type: array
4569
+ items:
4570
+ type: string
4571
+ description: Object tags to add. You can either add existing tags or create new ones
4572
+ clearCustomFields:
4573
+ type: array
4574
+ items:
4575
+ type: string
4576
+ description: List of custom fields to clear
4577
+ content:
4578
+ type: string
4579
+ description: New object content. The content must match the object type
4580
+ name:
4581
+ type: string
4582
+ description: New object name
4583
+ removeMembers:
4584
+ type: array
4585
+ items:
4586
+ $ref: '#/components/schemas/APIFlowNetworkEntityRequest'
4587
+ description: Group members to remove
4588
+ removeTags:
4589
+ type: array
4590
+ items:
4591
+ type: string
4592
+ description: Object tags to remove
4593
+ setCustomFields:
4594
+ type: array
4595
+ items:
4596
+ $ref: '#/components/schemas/APICustomFieldRequest'
4597
+ description: List of custom field values to set
4598
+ NetworkObjectsSaveLabelsRequest:
4599
+ title: NetworkObjectsSaveLabelsRequest
4600
+ type: object
4601
+ properties:
4602
+ labels:
4603
+ type: array
4604
+ items:
4605
+ type: string
4606
+ description: List of new network object tags
4607
+ NetworkServicesNewRequest:
4608
+ title: NetworkServicesNewRequest
4609
+ type: object
4610
+ properties:
4611
+ content:
4612
+ type: array
4613
+ items:
4614
+ $ref: '#/components/schemas/APINetworkServiceContent'
4615
+ description: List of service items
4616
+ custom_fields:
4617
+ type: array
4618
+ items:
4619
+ $ref: '#/components/schemas/APICustomFieldRequest'
4620
+ description: List of custom field values
4621
+ name:
4622
+ type: string
4623
+ description: Network service name
4624
+ NetworkServicesRequest:
4625
+ title: NetworkServicesRequest
4626
+ type: object
4627
+ properties:
4628
+ addContent:
4629
+ type: array
4630
+ items:
4631
+ $ref: '#/components/schemas/APINetworkServiceContent'
4632
+ description: List of service items to add
4633
+ clearCustomFields:
4634
+ type: array
4635
+ items:
4636
+ type: string
4637
+ description: List of custom field names to clear
4638
+ name:
4639
+ type: string
4640
+ description: New service name
4641
+ removeContent:
4642
+ type: array
4643
+ items:
4644
+ $ref: '#/components/schemas/APINetworkServiceContent'
4645
+ description: List of service items to remove
4646
+ setCustomFields:
4647
+ type: array
4648
+ items:
4649
+ $ref: '#/components/schemas/APICustomFieldRequest'
4650
+ description: List of custom field values
4651
+ NetworkObject:
4652
+ title: NetworkObject
4653
+ type: object
4654
+ properties:
4655
+ createdDate:
4656
+ $ref: '#/components/schemas/Calendar'
4657
+ customFields:
4658
+ type: array
4659
+ items:
4660
+ $ref: '#/components/schemas/APIProperty'
4661
+ description: List of custom field values
4662
+ devices:
4663
+ type: array
4664
+ items:
4665
+ type: string
4666
+ description: List of devices containing the object
4667
+ ipAddresses:
4668
+ type: array
4669
+ items:
4670
+ type: string
4671
+ description: List of IP addresses
4672
+ lastUpdateDate:
4673
+ $ref: '#/components/schemas/Calendar'
4674
+ members:
4675
+ type: array
4676
+ items:
4677
+ $ref: '#/components/schemas/RestNamedObject'
4678
+ description: List of group members
4679
+ name:
4680
+ type: string
4681
+ description: Object name
4682
+ objectID:
4683
+ type: integer
4684
+ description: Object id of the first revision
4685
+ format: int32
4686
+ objectType:
4687
+ type: string
4688
+ description: Object type
4689
+ origin:
4690
+ type: string
4691
+ description: Object origin
4692
+ revisionID:
4693
+ type: integer
4694
+ description: Object revision id
4695
+ format: int32
4696
+ revisionStatus:
4697
+ type: string
4698
+ description: Object revision status
4699
+ tags:
4700
+ type: object
4701
+ additionalProperties:
4702
+ type: object
4703
+ description: Network object tags by tag type
4704
+ vulnerabilityScore:
4705
+ type: integer
4706
+ description: Vulnerability score
4707
+ format: int32
4708
+ ReplaceWith:
4709
+ title: ReplaceWith
4710
+ type: object
4711
+ properties:
4712
+ device:
4713
+ type: string
4714
+ description: Network entity device
4715
+ name:
4716
+ type: string
4717
+ description: Network entity name
4718
+ objectID:
4719
+ type: integer
4720
+ description: Network entity ID
4721
+ format: int32
4722
+ SettingsPermissionsRoleNewRequest:
4723
+ title: SettingsPermissionsRoleNewRequest
4724
+ type: object
4725
+ properties:
4726
+ authorizedApplications:
4727
+ type: array
4728
+ items:
4729
+ $ref: '#/components/schemas/APIApplicationPermission'
4730
+ description: List of allowed application permissions
4731
+ authorizedViewsAndActions:
4732
+ type: array
4733
+ items:
4734
+ type: string
4735
+ description: List of allowed global permissions
4736
+ description:
4737
+ type: string
4738
+ description: Role description
4739
+ enabled:
4740
+ type: boolean
4741
+ description: Is enabled
4742
+ ldapGroupDN:
4743
+ type: string
4744
+ description: LDAP group DN
4745
+ name:
4746
+ type: string
4747
+ description: Role name
4748
+ users:
4749
+ type: array
4750
+ items:
4751
+ type: string
4752
+ description: List of user names assigned to the role
4753
+ SettingsPermissionsRoleRequest:
4754
+ title: SettingsPermissionsRoleRequest
4755
+ type: object
4756
+ properties:
4757
+ authorizedApplicationsChanges:
4758
+ $ref: '#/components/schemas/AuthorizedApplicationsChanges'
4759
+ authorizedViewsAndActionChanges:
4760
+ $ref: '#/components/schemas/AuthorizedViewsAndActionChanges'
4761
+ users:
4762
+ $ref: '#/components/schemas/Users'
4763
+ SettingsPermissionsUserRequest:
4764
+ title: SettingsPermissionsUserRequest
4765
+ type: object
4766
+ properties:
4767
+ authorizedApplicationsChanges:
4768
+ $ref: '#/components/schemas/AuthorizedApplicationsChanges'
4769
+ authorizedViewsAndActionChanges:
4770
+ $ref: '#/components/schemas/AuthorizedViewsAndActionChanges'
4771
+ type81:
4772
+ title: type81
4773
+ enum:
4774
+ - CRITICAL_PROCESS
4775
+ - USER_DEFINED
4776
+ - PCI
4777
+ - DYNAMIC
4778
+ - SYSTEM_TAGS
4779
+ - USER_TAGS
4780
+ type: string
4781
+ description: Tag type
4782
+ type91:
4783
+ title: type91
4784
+ enum:
4785
+ - DEFAULT
4786
+ - CONTAINED
4787
+ - CONTAINING
4788
+ - EXACT
4789
+ - INTERSECT
4790
+ - NONE
4791
+ - NAME
4792
+ - OBJECT
4793
+ - DISPLAY
4794
+ type: string
4795
+ description: The filter type
4796
+ Users:
4797
+ title: Users
4798
+ type: object
4799
+ properties:
4800
+ add:
4801
+ type: array
4802
+ items:
4803
+ type: string
4804
+ description: List of user names to add to the role
4805
+ remove:
4806
+ type: array
4807
+ items:
4808
+ type: string
4809
+ description: List of user names to remove from the role
4810
+ tags:
4811
+ - name: applications-api-controller
4812
+ description: Applications API Controller
4813
+ - name: flows-api-controller
4814
+ description: Flows API Controller
4815
+ - name: network-object-api-controller
4816
+ description: Network Object API Controller
4817
+ - name: network-service-api-controller
4818
+ description: Network Service API Controller
4819
+ - name: permissions-api-controller
4820
+ description: Permissions API Controller