@itentialopensource/adapter-algosec_fireflow 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 +78 -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 +159 -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 +1684 -0
  15. package/report/adapter-openapi.yaml +1142 -0
  16. package/report/adapterInfo.json +10 -0
  17. package/report/updateReport1691508682791.json +120 -0
  18. package/report/updateReport1692203134234.json +120 -0
  19. package/report/updateReport1694467838015.json +120 -0
  20. package/report/updateReport1698422447679.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,1142 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: >
4
+ AlgoSec FireFlow REST API
5
+ description: "Use the AlgoSec FireFlow REST APIs to perform remote FireFlow operations, such as creating various types of change requests or performing a saved search.\n\nFor AFF SOAP APIs, see the AFF SOAP API Reference in the ASMS Tech Docs. https://www.algosec.com/r/a32.20/1c07bca0\n\nSwagger is accessed from inside ASMS. Click Username > API Documentation.\n\nNote: You must be logged in to ASMS to execute these APIs. \n"
6
+ contact: {}
7
+ version: 'A32.20'
8
+ servers:
9
+ - url: https://{defaultHost}
10
+ variables:
11
+ defaultHost:
12
+ default: www.example.com/FireFlow/api
13
+ paths:
14
+ /change-requests/traffic/{changeRequestId}/work-order/implement:
15
+ post:
16
+ tags:
17
+ - active-change-external-controller
18
+ summary: calculateActiveChangeUsingPOST
19
+ description: Implement work-order recommendations of the given change request, using ActiveChange
20
+ operationId: calculateActiveChangeUsingPOST
21
+ parameters:
22
+ - name: changeRequestId
23
+ in: path
24
+ description: changeRequestId
25
+ required: true
26
+ style: simple
27
+ schema:
28
+ type: integer
29
+ format: int64
30
+ - name: Content-Type
31
+ in: header
32
+ description: ''
33
+ required: true
34
+ style: simple
35
+ schema:
36
+ $ref: '#/components/schemas/Content-Type'
37
+ responses:
38
+ '200':
39
+ description: Active change was triggered
40
+ headers: {}
41
+ content:
42
+ application/json:
43
+ schema:
44
+ $ref: '#/components/schemas/Response'
45
+ '400':
46
+ description: Input validation failure
47
+ headers: {}
48
+ content:
49
+ application/json:
50
+ schema:
51
+ $ref: '#/components/schemas/Response'
52
+ '403':
53
+ description: Authentication failure
54
+ headers: {}
55
+ content:
56
+ application/json:
57
+ schema:
58
+ $ref: '#/components/schemas/Response'
59
+ deprecated: false
60
+ /change-requests/traffic/{changeRequestId}/work-order/implementation/result:
61
+ get:
62
+ tags:
63
+ - active-change-external-controller
64
+ summary: getActiveChangeStatusUsingGET
65
+ description: Get ActiveChange results of the given change request
66
+ operationId: getActiveChangeStatusUsingGET
67
+ parameters:
68
+ - name: changeRequestId
69
+ in: path
70
+ description: changeRequestId
71
+ required: true
72
+ style: simple
73
+ schema:
74
+ type: integer
75
+ format: int64
76
+ responses:
77
+ '200':
78
+ description: Active change returns status
79
+ headers: {}
80
+ content:
81
+ application/json:
82
+ schema:
83
+ $ref: '#/components/schemas/Response'
84
+ '400':
85
+ description: Input validation failure
86
+ headers: {}
87
+ content:
88
+ application/json:
89
+ schema:
90
+ $ref: '#/components/schemas/Response'
91
+ '403':
92
+ description: Authentication failure
93
+ headers: {}
94
+ content:
95
+ application/json:
96
+ schema:
97
+ $ref: '#/components/schemas/Response'
98
+ deprecated: false
99
+ /authentication/authenticate:
100
+ post:
101
+ tags:
102
+ - authentication-external-controller
103
+ summary: authenticateUsingPOST
104
+ description: User authentication operation
105
+ operationId: authenticateUsingPOST
106
+ parameters: []
107
+ requestBody:
108
+ description: AuthenticationData, passed in JSON format
109
+ content:
110
+ application/json:
111
+ schema:
112
+ allOf:
113
+ - $ref: '#/components/schemas/AuthenticationData'
114
+ - description: AuthenticationData, passed in JSON format
115
+ required: true
116
+ responses:
117
+ '200':
118
+ description: Authentication has been successful
119
+ headers: {}
120
+ content:
121
+ application/json;charset=UTF-8:
122
+ schema:
123
+ $ref: '#/components/schemas/Response'
124
+ '403':
125
+ description: Authentication has been failed
126
+ headers: {}
127
+ content:
128
+ application/json;charset=UTF-8:
129
+ schema:
130
+ $ref: '#/components/schemas/Response'
131
+ deprecated: false
132
+ /request/object:
133
+ post:
134
+ tags:
135
+ - object-change-request-external-controller
136
+ summary: createObjectChangeRequestUsingPOST
137
+ description: Create Object Change request
138
+ operationId: createObjectChangeRequestUsingPOST
139
+ parameters: []
140
+ requestBody:
141
+ description: ObjectChangeRequestDetails, passed in JSON format
142
+ content:
143
+ application/json:
144
+ schema:
145
+ allOf:
146
+ - $ref: '#/components/schemas/ObjectChangeRequestDetails'
147
+ - description: ObjectChangeRequestDetails, passed in JSON format
148
+ required: true
149
+ responses:
150
+ '200':
151
+ description: OK
152
+ headers: {}
153
+ content:
154
+ application/json;charset=UTF-8:
155
+ schema:
156
+ $ref: '#/components/schemas/Response'
157
+ deprecated: false
158
+ /templates:
159
+ get:
160
+ tags:
161
+ - request-template-external-controller
162
+ summary: getTemplatesUsingGET
163
+ description: List all permitted request templates
164
+ operationId: getTemplatesUsingGET
165
+ parameters: []
166
+ responses:
167
+ '200':
168
+ description: OK
169
+ headers: {}
170
+ content:
171
+ '*/*':
172
+ schema: {}
173
+ deprecated: false
174
+ /change-requests/rule-removal:
175
+ post:
176
+ tags:
177
+ - rule-removal-change-request-external-controller
178
+ summary: createRuleRemovalRequestUsingPOST
179
+ description: Create Rule Removal Change Request
180
+ operationId: createRuleRemovalRequestUsingPOST
181
+ parameters: []
182
+ requestBody:
183
+ description: >-
184
+ RuleRemovalChangeRequest, passed in JSON format
185
+
186
+
187
+ Required fields: You must include a devices field, with a single device listed.
188
+
189
+ Multiple devices are not supported.
190
+ content:
191
+ application/json:
192
+ schema:
193
+ allOf:
194
+ - $ref: '#/components/schemas/RuleRemovalChangeRequest'
195
+ - description: >-
196
+ RuleRemovalChangeRequest, passed in JSON format
197
+
198
+
199
+ Required fields: You must include a devices field, with a single device listed.
200
+
201
+ Multiple devices are not supported.
202
+ required: true
203
+ responses:
204
+ '200':
205
+ description: Rule Removal Change Request created
206
+ headers: {}
207
+ content:
208
+ application/json;charset=UTF-8:
209
+ schema:
210
+ $ref: '#/components/schemas/Response'
211
+ '400':
212
+ description: Input validation failure
213
+ headers: {}
214
+ content:
215
+ application/json;charset=UTF-8:
216
+ schema:
217
+ $ref: '#/components/schemas/Response'
218
+ '403':
219
+ description: Authentication failure
220
+ headers: {}
221
+ content:
222
+ application/json;charset=UTF-8:
223
+ schema:
224
+ $ref: '#/components/schemas/Response'
225
+ deprecated: false
226
+ /savedsearch:
227
+ get:
228
+ tags:
229
+ - saved-search-controller
230
+ summary: getSavedSearchByNameProxyUsingGET
231
+ description: Find Saved Search results by name
232
+ operationId: getSavedSearchByNameProxyUsingGET
233
+ parameters:
234
+ - name: savedSearchName
235
+ in: query
236
+ description: Name of Saved Search
237
+ required: true
238
+ style: form
239
+ explode: true
240
+ schema:
241
+ type: string
242
+ responses:
243
+ '200':
244
+ description: OK
245
+ headers: {}
246
+ content:
247
+ application/json;charset=UTF-8:
248
+ schema:
249
+ $ref: '#/components/schemas/Response'
250
+ deprecated: false
251
+ /session:
252
+ get:
253
+ tags:
254
+ - session-external-controller
255
+ summary: verifySessionStatusUsingGET
256
+ description: Checks if a session is alive by entering a session cookie in the request header. This endpoint cannot be tested from the swagger client. Use other REST clients.
257
+ operationId: verifySessionStatusUsingGET
258
+ parameters: []
259
+ responses:
260
+ '200':
261
+ description: OK
262
+ headers: {}
263
+ content:
264
+ application/json:
265
+ schema:
266
+ $ref: '#/components/schemas/SessionRespose'
267
+ deprecated: false
268
+ /change-requests/traffic:
269
+ post:
270
+ tags:
271
+ - traffic-change-request-external-controller
272
+ summary: createTrafficChangeRequestUsingPOST
273
+ description: Create Traffic Change request
274
+ operationId: createTrafficChangeRequestUsingPOST
275
+ parameters: []
276
+ requestBody:
277
+ description: TrafficChangeRequest, passed in JSON format
278
+ content:
279
+ application/json:
280
+ schema:
281
+ allOf:
282
+ - $ref: '#/components/schemas/TrafficChangeRequest'
283
+ - description: TrafficChangeRequest, passed in JSON format
284
+ required: true
285
+ responses:
286
+ '200':
287
+ description: OK
288
+ headers: {}
289
+ content:
290
+ '*/*':
291
+ schema: {}
292
+ deprecated: false
293
+ /change-requests/traffic/{changeRequestId}:
294
+ get:
295
+ tags:
296
+ - traffic-change-request-external-controller
297
+ summary: getTicketUsingGET
298
+ description: Get Ticket details by change request id number
299
+ operationId: getTicketUsingGET
300
+ parameters:
301
+ - name: changeRequestId
302
+ in: path
303
+ description: Id of the Change Request
304
+ required: true
305
+ style: simple
306
+ schema:
307
+ type: integer
308
+ format: int64
309
+ responses:
310
+ '200':
311
+ description: OK
312
+ headers: {}
313
+ content:
314
+ '*/*':
315
+ schema: {}
316
+ deprecated: false
317
+ /change-requests/traffic/{changeRequestId}/fields:
318
+ put:
319
+ tags:
320
+ - traffic-change-request-external-controller
321
+ summary: updateTrafficChangeRequestCustomFieldsUsingPUT
322
+ description: Update Traffic Change request's custom fields
323
+ operationId: updateTrafficChangeRequestCustomFieldsUsingPUT
324
+ parameters:
325
+ - name: changeRequestId
326
+ in: path
327
+ description: Id of the Change request
328
+ required: true
329
+ style: simple
330
+ schema:
331
+ type: integer
332
+ format: int64
333
+ requestBody:
334
+ description: List of fields, passed in JSON format
335
+ content:
336
+ application/json:
337
+ schema:
338
+ type: array
339
+ items:
340
+ $ref: '#/components/schemas/Fields'
341
+ description: List of fields, passed in JSON format
342
+ required: true
343
+ responses:
344
+ '200':
345
+ description: OK
346
+ headers: {}
347
+ content:
348
+ '*/*':
349
+ schema: {}
350
+ deprecated: false
351
+ /change-request/traffic/{changeRequestId}/work-order/calculate:
352
+ post:
353
+ tags:
354
+ - work-order-external-controller
355
+ summary: calculateWorkOrderUsingPOST
356
+ description: Trigger work order calculation for change request
357
+ operationId: calculateWorkOrderUsingPOST
358
+ parameters:
359
+ - name: changeRequestId
360
+ in: path
361
+ description: changeRequestId
362
+ required: true
363
+ style: simple
364
+ schema:
365
+ type: integer
366
+ format: int64
367
+ - name: Content-Type
368
+ in: header
369
+ description: ''
370
+ required: true
371
+ style: simple
372
+ schema:
373
+ $ref: '#/components/schemas/Content-Type'
374
+ responses:
375
+ '200':
376
+ description: Work order calculation was triggered
377
+ headers: {}
378
+ content:
379
+ application/json:
380
+ schema:
381
+ $ref: '#/components/schemas/Response'
382
+ '400':
383
+ description: Input validation failure
384
+ headers: {}
385
+ content:
386
+ application/json:
387
+ schema:
388
+ $ref: '#/components/schemas/Response'
389
+ '403':
390
+ description: Authentication failure
391
+ headers: {}
392
+ content:
393
+ application/json:
394
+ schema:
395
+ $ref: '#/components/schemas/Response'
396
+ deprecated: false
397
+ /change-request/traffic/{changeRequestId}/work-order/calculation/status:
398
+ get:
399
+ tags:
400
+ - work-order-external-controller
401
+ summary: getWorkOrderCalculationStatusUsingGET
402
+ description: Get work order calculation status for change request
403
+ operationId: getWorkOrderCalculationStatusUsingGET
404
+ parameters:
405
+ - name: changeRequestId
406
+ in: path
407
+ description: changeRequestId
408
+ required: true
409
+ style: simple
410
+ schema:
411
+ type: integer
412
+ format: int64
413
+ responses:
414
+ '200':
415
+ description: Work order calculation returns status
416
+ headers: {}
417
+ content:
418
+ application/json:
419
+ schema:
420
+ $ref: '#/components/schemas/Response'
421
+ '400':
422
+ description: Input validation failure
423
+ headers: {}
424
+ content:
425
+ application/json:
426
+ schema:
427
+ $ref: '#/components/schemas/Response'
428
+ '403':
429
+ description: Authentication failure
430
+ headers: {}
431
+ content:
432
+ application/json:
433
+ schema:
434
+ $ref: '#/components/schemas/Response'
435
+ deprecated: false
436
+ components:
437
+ schemas:
438
+ Action:
439
+ title: Action
440
+ required:
441
+ - action
442
+ type: object
443
+ properties:
444
+ devices:
445
+ type: array
446
+ items:
447
+ type: string
448
+ description: ''
449
+ lineOrder:
450
+ type: integer
451
+ format: int32
452
+ name:
453
+ type: string
454
+ objectContainers:
455
+ type: array
456
+ items:
457
+ type: integer
458
+ format: int64
459
+ description: ''
460
+ type:
461
+ $ref: '#/components/schemas/Type'
462
+ valuableServiceObject:
463
+ type: boolean
464
+ action:
465
+ type: string
466
+ discriminator:
467
+ propertyName: action
468
+ mapping:
469
+ AddObjectsToGroup: AddObjectsToGroup
470
+ Create: Create
471
+ Delete: Delete
472
+ RemoveObjectsFromGroup: RemoveObjectsFromGroup
473
+ ReplaceContent: ReplaceContent
474
+ AddObjectsToGroup:
475
+ title: AddObjectsToGroup
476
+ allOf:
477
+ - $ref: '#/components/schemas/Action'
478
+ - type: object
479
+ properties:
480
+ devices:
481
+ type: array
482
+ items:
483
+ type: string
484
+ description: ''
485
+ lineOrder:
486
+ type: integer
487
+ format: int32
488
+ name:
489
+ type: string
490
+ objectContainers:
491
+ type: array
492
+ items:
493
+ type: integer
494
+ format: int64
495
+ description: ''
496
+ type:
497
+ $ref: '#/components/schemas/Type'
498
+ valuableServiceObject:
499
+ type: boolean
500
+ values:
501
+ type: array
502
+ items:
503
+ type: string
504
+ description: ''
505
+ AddressTrafficFieldDetails:
506
+ title: AddressTrafficFieldDetails
507
+ type: object
508
+ properties:
509
+ items:
510
+ type: array
511
+ items:
512
+ $ref: '#/components/schemas/AddressTrafficItemDetails'
513
+ description: ''
514
+ AddressTrafficItemDetails:
515
+ title: AddressTrafficItemDetails
516
+ type: object
517
+ properties:
518
+ address:
519
+ type: string
520
+ example: 1.1.1.1
521
+ fields:
522
+ type: array
523
+ items:
524
+ $ref: '#/components/schemas/Fields'
525
+ description: ''
526
+ AuthenticationData:
527
+ title: AuthenticationData
528
+ required:
529
+ - username
530
+ - password
531
+ type: object
532
+ properties:
533
+ username:
534
+ type: string
535
+ description: User name
536
+ example: admin
537
+ password:
538
+ type: string
539
+ description: User password
540
+ example: pass
541
+ domain:
542
+ type: string
543
+ description: Domain id
544
+ example: '0'
545
+ Create:
546
+ title: Create
547
+ allOf:
548
+ - $ref: '#/components/schemas/Action'
549
+ - type: object
550
+ properties:
551
+ devices:
552
+ type: array
553
+ items:
554
+ type: string
555
+ description: ''
556
+ group:
557
+ type: boolean
558
+ isGroup:
559
+ type: boolean
560
+ lineOrder:
561
+ type: integer
562
+ format: int32
563
+ name:
564
+ type: string
565
+ objectContainers:
566
+ type: array
567
+ items:
568
+ type: integer
569
+ format: int64
570
+ description: ''
571
+ type:
572
+ $ref: '#/components/schemas/Type'
573
+ valuableServiceObject:
574
+ type: boolean
575
+ values:
576
+ type: array
577
+ items:
578
+ type: string
579
+ description: ''
580
+ Delete:
581
+ title: Delete
582
+ allOf:
583
+ - $ref: '#/components/schemas/Action'
584
+ - type: object
585
+ properties:
586
+ devices:
587
+ type: array
588
+ items:
589
+ type: string
590
+ description: ''
591
+ lineOrder:
592
+ type: integer
593
+ format: int32
594
+ name:
595
+ type: string
596
+ objectContainers:
597
+ type: array
598
+ items:
599
+ type: integer
600
+ format: int64
601
+ description: ''
602
+ type:
603
+ $ref: '#/components/schemas/Type'
604
+ valuableServiceObject:
605
+ type: boolean
606
+ Field:
607
+ title: Field
608
+ type: object
609
+ properties:
610
+ name:
611
+ type: string
612
+ example: field name
613
+ values:
614
+ type: array
615
+ items:
616
+ type: string
617
+ description: ''
618
+ example:
619
+ - field value 1
620
+ - field value 2
621
+ Fields:
622
+ title: Fields
623
+ type: object
624
+ properties:
625
+ name:
626
+ type: string
627
+ example: custom field name
628
+ values:
629
+ type: array
630
+ items:
631
+ type: string
632
+ description: ''
633
+ example:
634
+ - custom field value 1
635
+ - custom field value 2
636
+ MessageDetails:
637
+ title: MessageDetails
638
+ type: object
639
+ properties:
640
+ code:
641
+ type: string
642
+ message:
643
+ type: string
644
+ NameTrafficFieldDetails:
645
+ title: NameTrafficFieldDetails
646
+ type: object
647
+ properties:
648
+ items:
649
+ type: array
650
+ items:
651
+ $ref: '#/components/schemas/NameTrafficItemDetails'
652
+ description: ''
653
+ NameTrafficItemDetails:
654
+ title: NameTrafficItemDetails
655
+ type: object
656
+ properties:
657
+ name:
658
+ type: string
659
+ example: name to match
660
+ fields:
661
+ type: array
662
+ items:
663
+ $ref: '#/components/schemas/Fields'
664
+ description: ''
665
+ Nat:
666
+ title: Nat
667
+ type: object
668
+ properties:
669
+ source:
670
+ type: array
671
+ items:
672
+ type: string
673
+ description: ''
674
+ destination:
675
+ type: array
676
+ items:
677
+ type: string
678
+ description: ''
679
+ port:
680
+ type: array
681
+ items:
682
+ type: string
683
+ description: ''
684
+ type:
685
+ $ref: '#/components/schemas/Type4'
686
+ NatDetails:
687
+ title: NatDetails
688
+ type: object
689
+ properties:
690
+ source:
691
+ type: array
692
+ items:
693
+ type: string
694
+ description: ''
695
+ destination:
696
+ type: array
697
+ items:
698
+ type: string
699
+ description: ''
700
+ port:
701
+ type: array
702
+ items:
703
+ type: string
704
+ description: ''
705
+ type:
706
+ $ref: '#/components/schemas/Type4'
707
+ ObjectChangeRequestDetails:
708
+ title: ObjectChangeRequestDetails
709
+ required:
710
+ - template
711
+ - fields
712
+ - devices
713
+ - requestedActions
714
+ type: object
715
+ properties:
716
+ template:
717
+ type: string
718
+ fields:
719
+ type: array
720
+ items:
721
+ $ref: '#/components/schemas/Fields'
722
+ description: ''
723
+ subject:
724
+ type: string
725
+ cc:
726
+ type: array
727
+ items:
728
+ type: string
729
+ description: ''
730
+ description:
731
+ type: string
732
+ devices:
733
+ type: array
734
+ items:
735
+ type: string
736
+ description: ''
737
+ due:
738
+ type: string
739
+ expire:
740
+ type: string
741
+ externalId:
742
+ type: string
743
+ owner:
744
+ type: string
745
+ priority:
746
+ type: string
747
+ refersTo:
748
+ type: array
749
+ items:
750
+ type: string
751
+ description: ''
752
+ referredBy:
753
+ type: array
754
+ items:
755
+ type: string
756
+ description: ''
757
+ requestor:
758
+ type: string
759
+ requestedActions:
760
+ type: array
761
+ items:
762
+ $ref: '#/components/schemas/Action'
763
+ description: Requested actions
764
+ objectContainerLevel:
765
+ $ref: '#/components/schemas/ObjectContainerLevel'
766
+ RemoveObjectsFromGroup:
767
+ title: RemoveObjectsFromGroup
768
+ allOf:
769
+ - $ref: '#/components/schemas/Action'
770
+ - type: object
771
+ properties:
772
+ devices:
773
+ type: array
774
+ items:
775
+ type: string
776
+ description: ''
777
+ lineOrder:
778
+ type: integer
779
+ format: int32
780
+ name:
781
+ type: string
782
+ objectContainers:
783
+ type: array
784
+ items:
785
+ type: integer
786
+ format: int64
787
+ description: ''
788
+ type:
789
+ $ref: '#/components/schemas/Type'
790
+ valuableServiceObject:
791
+ type: boolean
792
+ values:
793
+ type: array
794
+ items:
795
+ type: string
796
+ description: ''
797
+ ReplaceContent:
798
+ title: ReplaceContent
799
+ allOf:
800
+ - $ref: '#/components/schemas/Action'
801
+ - type: object
802
+ properties:
803
+ devices:
804
+ type: array
805
+ items:
806
+ type: string
807
+ description: ''
808
+ lineOrder:
809
+ type: integer
810
+ format: int32
811
+ name:
812
+ type: string
813
+ objectContainers:
814
+ type: array
815
+ items:
816
+ type: integer
817
+ format: int64
818
+ description: ''
819
+ type:
820
+ $ref: '#/components/schemas/Type'
821
+ valuableServiceObject:
822
+ type: boolean
823
+ values:
824
+ type: array
825
+ items:
826
+ type: string
827
+ description: ''
828
+ RequestTemplateData:
829
+ title: RequestTemplateData
830
+ type: object
831
+ properties:
832
+ description:
833
+ type: string
834
+ enabled:
835
+ type: boolean
836
+ id:
837
+ type: integer
838
+ format: int32
839
+ name:
840
+ type: string
841
+ type:
842
+ $ref: '#/components/schemas/Type8'
843
+ Response:
844
+ title: Response
845
+ type: object
846
+ properties:
847
+ data:
848
+ type: object
849
+ messages:
850
+ type: array
851
+ items:
852
+ $ref: '#/components/schemas/MessageDetails'
853
+ description: ''
854
+ status:
855
+ $ref: '#/components/schemas/Status'
856
+ ResponseOfListOfRequestTemplateData:
857
+ title: ResponseOfListOfRequestTemplateData
858
+ type: object
859
+ properties:
860
+ data:
861
+ type: array
862
+ items:
863
+ $ref: '#/components/schemas/RequestTemplateData'
864
+ description: ''
865
+ messages:
866
+ type: array
867
+ items:
868
+ $ref: '#/components/schemas/MessageDetails'
869
+ description: ''
870
+ status:
871
+ $ref: '#/components/schemas/Status'
872
+ RuleRemovalChangeRequest:
873
+ title: RuleRemovalChangeRequest
874
+ required:
875
+ - template
876
+ - fields
877
+ - requestActions
878
+ type: object
879
+ properties:
880
+ template:
881
+ type: string
882
+ fields:
883
+ type: array
884
+ items:
885
+ $ref: '#/components/schemas/Fields'
886
+ description: ''
887
+ requestActions:
888
+ type: array
889
+ items:
890
+ $ref: '#/components/schemas/RuleRemovalRequestedUnit'
891
+ description: Request actions
892
+ RuleRemovalRequestedUnit:
893
+ title: RuleRemovalRequestedUnit
894
+ type: object
895
+ properties:
896
+ action:
897
+ $ref: '#/components/schemas/Action1'
898
+ ruleId:
899
+ type: string
900
+ ServiceTrafficFieldDetails:
901
+ title: ServiceTrafficFieldDetails
902
+ type: object
903
+ properties:
904
+ items:
905
+ type: array
906
+ items:
907
+ $ref: '#/components/schemas/ServiceTrafficItemDetails'
908
+ description: ''
909
+ ServiceTrafficItemDetails:
910
+ title: ServiceTrafficItemDetails
911
+ type: object
912
+ properties:
913
+ service:
914
+ type: string
915
+ example: tcp/80
916
+ fields:
917
+ type: array
918
+ items:
919
+ $ref: '#/components/schemas/Fields'
920
+ description: ''
921
+ SessionRespose:
922
+ title: SessionRespose
923
+ type: object
924
+ properties:
925
+ message:
926
+ $ref: '#/components/schemas/MessageDetails'
927
+ valid:
928
+ type: boolean
929
+ TrafficChangeRequest:
930
+ title: TrafficChangeRequest
931
+ required:
932
+ - template
933
+ - fields
934
+ - traffic
935
+ type: object
936
+ properties:
937
+ template:
938
+ type: string
939
+ fields:
940
+ type: array
941
+ items:
942
+ $ref: '#/components/schemas/Fields'
943
+ description: ''
944
+ traffic:
945
+ type: array
946
+ items:
947
+ $ref: '#/components/schemas/TrafficLineDetails'
948
+ description: traffic
949
+ TrafficChangeRequestData:
950
+ title: TrafficChangeRequestData
951
+ type: object
952
+ properties:
953
+ id:
954
+ type: integer
955
+ format: int64
956
+ subChangeRequests:
957
+ type: array
958
+ items:
959
+ type: integer
960
+ format: int64
961
+ description: sub change request ids
962
+ fields:
963
+ type: array
964
+ items:
965
+ $ref: '#/components/schemas/Field'
966
+ description: change request fields
967
+ originalTraffic:
968
+ type: array
969
+ items:
970
+ $ref: '#/components/schemas/TrafficLine'
971
+ description: original traffic requested by creator; available only for parent change request
972
+ plannedTraffic:
973
+ type: array
974
+ items:
975
+ $ref: '#/components/schemas/TrafficLine'
976
+ description: traffic that is planned to implement
977
+ TrafficChangeRequestResponse:
978
+ title: TrafficChangeRequestResponse
979
+ type: object
980
+ properties:
981
+ data:
982
+ $ref: '#/components/schemas/TrafficChangeRequestData'
983
+ messages:
984
+ type: array
985
+ items:
986
+ $ref: '#/components/schemas/MessageDetails'
987
+ description: ''
988
+ status:
989
+ $ref: '#/components/schemas/Status'
990
+ TrafficField:
991
+ title: TrafficField
992
+ type: object
993
+ properties:
994
+ items:
995
+ type: array
996
+ items:
997
+ $ref: '#/components/schemas/TrafficItem'
998
+ description: ''
999
+ TrafficItem:
1000
+ title: TrafficItem
1001
+ type: object
1002
+ properties:
1003
+ value:
1004
+ type: string
1005
+ fields:
1006
+ type: array
1007
+ items:
1008
+ $ref: '#/components/schemas/Field'
1009
+ description: custom fields related to the item
1010
+ TrafficLine:
1011
+ title: TrafficLine
1012
+ type: object
1013
+ properties:
1014
+ source:
1015
+ $ref: '#/components/schemas/TrafficField'
1016
+ destination:
1017
+ $ref: '#/components/schemas/TrafficField'
1018
+ service:
1019
+ $ref: '#/components/schemas/TrafficField'
1020
+ application:
1021
+ $ref: '#/components/schemas/TrafficField'
1022
+ user:
1023
+ $ref: '#/components/schemas/TrafficField'
1024
+ fields:
1025
+ type: array
1026
+ items:
1027
+ $ref: '#/components/schemas/Field'
1028
+ description: ''
1029
+ natDetails:
1030
+ $ref: '#/components/schemas/Nat'
1031
+ action:
1032
+ $ref: '#/components/schemas/Action2'
1033
+ TrafficLineDetails:
1034
+ title: TrafficLineDetails
1035
+ required:
1036
+ - source
1037
+ - destination
1038
+ - service
1039
+ - application
1040
+ - user
1041
+ - natDetails
1042
+ - fields
1043
+ type: object
1044
+ properties:
1045
+ source:
1046
+ $ref: '#/components/schemas/AddressTrafficFieldDetails'
1047
+ destination:
1048
+ $ref: '#/components/schemas/AddressTrafficFieldDetails'
1049
+ service:
1050
+ $ref: '#/components/schemas/ServiceTrafficFieldDetails'
1051
+ application:
1052
+ $ref: '#/components/schemas/NameTrafficFieldDetails'
1053
+ user:
1054
+ $ref: '#/components/schemas/NameTrafficFieldDetails'
1055
+ action:
1056
+ type: string
1057
+ example: Allow/Drop
1058
+ natDetails:
1059
+ $ref: '#/components/schemas/NatDetails'
1060
+ fields:
1061
+ type: array
1062
+ items:
1063
+ $ref: '#/components/schemas/Fields'
1064
+ description: fields
1065
+ Action1:
1066
+ title: Action1
1067
+ enum:
1068
+ - remove
1069
+ - disable
1070
+ type: string
1071
+ Action2:
1072
+ title: Action2
1073
+ enum:
1074
+ - Allow
1075
+ - Drop
1076
+ type: string
1077
+ ObjectContainerLevel:
1078
+ title: ObjectContainerLevel
1079
+ enum:
1080
+ - Lowest
1081
+ - Highest
1082
+ - Automatic
1083
+ - Invalid
1084
+ type: string
1085
+ description: Object container level
1086
+ Status:
1087
+ title: Status
1088
+ enum:
1089
+ - Success
1090
+ - Failure
1091
+ type: string
1092
+ Type:
1093
+ title: Type
1094
+ enum:
1095
+ - network
1096
+ - service
1097
+ type: string
1098
+ Type4:
1099
+ title: Type4
1100
+ enum:
1101
+ - Static
1102
+ - Dynamic
1103
+ - None
1104
+ type: string
1105
+ Type8:
1106
+ title: Type8
1107
+ enum:
1108
+ - Generic Change
1109
+ - Object Change
1110
+ - Object Change Multi Device
1111
+ - Request Recertification
1112
+ - Rule Modification
1113
+ - Rule Removal
1114
+ - Traffic Change
1115
+ - Traffic Change IPv6
1116
+ - Unknown
1117
+ - Web Filter Change
1118
+ type: string
1119
+ Content-Type:
1120
+ title: Content-Type
1121
+ enum:
1122
+ - application/json
1123
+ type: string
1124
+ tags:
1125
+ - name: active-change-external-controller
1126
+ description: Active Change External Controller
1127
+ - name: authentication-external-controller
1128
+ description: Authentication External Controller
1129
+ - name: object-change-request-external-controller
1130
+ description: Object Change Request External Controller
1131
+ - name: request-template-external-controller
1132
+ description: Request Template External Controller
1133
+ - name: rule-removal-change-request-external-controller
1134
+ description: Rule Removal Change Request External Controller
1135
+ - name: saved-search-controller
1136
+ description: Saved Search Controller
1137
+ - name: session-external-controller
1138
+ description: Session External Controller
1139
+ - name: traffic-change-request-external-controller
1140
+ description: Traffic Change Request External Controller
1141
+ - name: work-order-external-controller
1142
+ description: Work Order External Controller