@itentialopensource/adapter-algosec_fireflow 0.1.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 (77) hide show
  1. package/.eslintignore +5 -0
  2. package/.eslintrc.js +18 -0
  3. package/.jshintrc +3 -0
  4. package/AUTH.md +39 -0
  5. package/BROKER.md +199 -0
  6. package/CALLS.md +170 -0
  7. package/CHANGELOG.md +9 -0
  8. package/CODE_OF_CONDUCT.md +43 -0
  9. package/CONTRIBUTING.md +172 -0
  10. package/ENHANCE.md +69 -0
  11. package/LICENSE +201 -0
  12. package/PROPERTIES.md +641 -0
  13. package/README.md +337 -0
  14. package/SUMMARY.md +9 -0
  15. package/SYSTEMINFO.md +11 -0
  16. package/TROUBLESHOOT.md +47 -0
  17. package/adapter.js +1908 -0
  18. package/adapterBase.js +1787 -0
  19. package/entities/.generic/action.json +214 -0
  20. package/entities/.generic/schema.json +28 -0
  21. package/entities/.system/action.json +50 -0
  22. package/entities/.system/mockdatafiles/getToken-default.json +14 -0
  23. package/entities/.system/mockdatafiles/healthcheck-default.json +3 -0
  24. package/entities/.system/schema.json +19 -0
  25. package/entities/.system/schemaTokenReq.json +53 -0
  26. package/entities/.system/schemaTokenResp.json +53 -0
  27. package/entities/ActiveChangeExternalController/action.json +45 -0
  28. package/entities/ActiveChangeExternalController/schema.json +20 -0
  29. package/entities/AuthenticationExternalController/action.json +24 -0
  30. package/entities/AuthenticationExternalController/schema.json +19 -0
  31. package/entities/ObjectChangeRequestExternalController/action.json +24 -0
  32. package/entities/ObjectChangeRequestExternalController/schema.json +19 -0
  33. package/entities/RequestTemplateExternalController/action.json +25 -0
  34. package/entities/RequestTemplateExternalController/schema.json +19 -0
  35. package/entities/RuleRemovalChangeRequestExternalController/action.json +24 -0
  36. package/entities/RuleRemovalChangeRequestExternalController/schema.json +19 -0
  37. package/entities/SavedSearchController/action.json +25 -0
  38. package/entities/SavedSearchController/schema.json +19 -0
  39. package/entities/SessionExternalController/action.json +25 -0
  40. package/entities/SessionExternalController/schema.json +19 -0
  41. package/entities/TrafficChangeRequestExternalController/action.json +65 -0
  42. package/entities/TrafficChangeRequestExternalController/schema.json +21 -0
  43. package/entities/WorkOrderExternalController/action.json +45 -0
  44. package/entities/WorkOrderExternalController/schema.json +20 -0
  45. package/error.json +190 -0
  46. package/package.json +86 -0
  47. package/pronghorn.json +1672 -0
  48. package/propertiesDecorators.json +14 -0
  49. package/propertiesSchema.json +1248 -0
  50. package/refs?service=git-upload-pack +0 -0
  51. package/report/algosec-FireFlow-swagger.json +1476 -0
  52. package/report/creationReport.json +395 -0
  53. package/sampleProperties.json +195 -0
  54. package/test/integration/adapterTestBasicGet.js +83 -0
  55. package/test/integration/adapterTestConnectivity.js +93 -0
  56. package/test/integration/adapterTestIntegration.js +758 -0
  57. package/test/unit/adapterBaseTestUnit.js +949 -0
  58. package/test/unit/adapterTestUnit.js +1671 -0
  59. package/utils/adapterInfo.js +206 -0
  60. package/utils/addAuth.js +94 -0
  61. package/utils/artifactize.js +146 -0
  62. package/utils/basicGet.js +50 -0
  63. package/utils/checkMigrate.js +63 -0
  64. package/utils/entitiesToDB.js +178 -0
  65. package/utils/findPath.js +74 -0
  66. package/utils/methodDocumentor.js +225 -0
  67. package/utils/modify.js +154 -0
  68. package/utils/packModificationScript.js +35 -0
  69. package/utils/patches2bundledDeps.js +90 -0
  70. package/utils/pre-commit.sh +32 -0
  71. package/utils/removeHooks.js +20 -0
  72. package/utils/setup.js +33 -0
  73. package/utils/tbScript.js +246 -0
  74. package/utils/tbUtils.js +490 -0
  75. package/utils/testRunner.js +298 -0
  76. package/utils/troubleshootingAdapter.js +195 -0
  77. package/workflows/README.md +3 -0
@@ -0,0 +1,1476 @@
1
+ {
2
+ "swagger": "2.0",
3
+ "info": {
4
+ "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",
5
+ "version": "A32.20",
6
+ "title": "AlgoSec FireFlow REST API\n"
7
+ },
8
+ "basePath": "/FireFlow/api",
9
+ "tags": [{
10
+ "name": "active-change-external-controller",
11
+ "description": "Active Change External Controller"
12
+ }, {
13
+ "name": "authentication-external-controller",
14
+ "description": "Authentication External Controller"
15
+ }, {
16
+ "name": "object-change-request-external-controller",
17
+ "description": "Object Change Request External Controller"
18
+ }, {
19
+ "name": "request-template-external-controller",
20
+ "description": "Request Template External Controller"
21
+ }, {
22
+ "name": "rule-removal-change-request-external-controller",
23
+ "description": "Rule Removal Change Request External Controller"
24
+ }, {
25
+ "name": "saved-search-controller",
26
+ "description": "Saved Search Controller"
27
+ }, {
28
+ "name": "session-external-controller",
29
+ "description": "Session External Controller"
30
+ }, {
31
+ "name": "traffic-change-request-external-controller",
32
+ "description": "Traffic Change Request External Controller"
33
+ }, {
34
+ "name": "work-order-external-controller",
35
+ "description": "Work Order External Controller"
36
+ }],
37
+ "paths": {
38
+ "/authentication/authenticate": {
39
+ "post": {
40
+ "tags": ["authentication-external-controller"],
41
+ "summary": "User authentication operation",
42
+ "operationId": "authenticateUsingPOST",
43
+ "consumes": ["application/json"],
44
+ "produces": ["application/json;charset=UTF-8"],
45
+ "parameters": [{
46
+ "in": "body",
47
+ "name": "authenticationData",
48
+ "description": "AuthenticationData, passed in JSON format",
49
+ "required": true,
50
+ "schema": {
51
+ "$ref": "#/definitions/AuthenticationData"
52
+ }
53
+ }],
54
+ "responses": {
55
+ "200": {
56
+ "description": "Authentication has been successful",
57
+ "schema": {
58
+ "$ref": "#/definitions/Response"
59
+ }
60
+ },
61
+ "403": {
62
+ "description": "Authentication has been failed",
63
+ "schema": {
64
+ "$ref": "#/definitions/Response"
65
+ }
66
+ }
67
+ },
68
+ "deprecated": false
69
+ }
70
+ },
71
+ "/change-request/traffic/{changeRequestId}/work-order/calculate": {
72
+ "post": {
73
+ "tags": ["work-order-external-controller"],
74
+ "summary": "Trigger work order calculation for change request",
75
+ "operationId": "calculateWorkOrderUsingPOST",
76
+ "consumes": ["application/json"],
77
+ "produces": ["application/json"],
78
+ "parameters": [{
79
+ "name": "changeRequestId",
80
+ "in": "path",
81
+ "description": "changeRequestId",
82
+ "required": true,
83
+ "type": "integer",
84
+ "format": "int64"
85
+ }],
86
+ "responses": {
87
+ "200": {
88
+ "description": "Work order calculation was triggered",
89
+ "schema": {
90
+ "$ref": "#/definitions/Response"
91
+ }
92
+ },
93
+ "400": {
94
+ "description": "Input validation failure",
95
+ "schema": {
96
+ "$ref": "#/definitions/Response"
97
+ }
98
+ },
99
+ "403": {
100
+ "description": "Authentication failure",
101
+ "schema": {
102
+ "$ref": "#/definitions/Response"
103
+ }
104
+ }
105
+ },
106
+ "deprecated": false
107
+ }
108
+ },
109
+ "/change-request/traffic/{changeRequestId}/work-order/calculation/status": {
110
+ "get": {
111
+ "tags": ["work-order-external-controller"],
112
+ "summary": "Get work order calculation status for change request",
113
+ "operationId": "getWorkOrderCalculationStatusUsingGET",
114
+ "produces": ["application/json"],
115
+ "parameters": [{
116
+ "name": "changeRequestId",
117
+ "in": "path",
118
+ "description": "changeRequestId",
119
+ "required": true,
120
+ "type": "integer",
121
+ "format": "int64"
122
+ }],
123
+ "responses": {
124
+ "200": {
125
+ "description": "Work order calculation returns status",
126
+ "schema": {
127
+ "$ref": "#/definitions/Response"
128
+ }
129
+ },
130
+ "400": {
131
+ "description": "Input validation failure",
132
+ "schema": {
133
+ "$ref": "#/definitions/Response"
134
+ }
135
+ },
136
+ "403": {
137
+ "description": "Authentication failure",
138
+ "schema": {
139
+ "$ref": "#/definitions/Response"
140
+ }
141
+ }
142
+ },
143
+ "deprecated": false
144
+ }
145
+ },
146
+ "/change-requests/rule-removal": {
147
+ "post": {
148
+ "tags": ["rule-removal-change-request-external-controller"],
149
+ "summary": "Create Rule Removal Change Request",
150
+ "operationId": "createRuleRemovalRequestUsingPOST",
151
+ "consumes": ["application/json"],
152
+ "produces": ["application/json;charset=UTF-8"],
153
+ "parameters": [{
154
+ "in": "body",
155
+ "name": "ruleRemovalChangeRequest",
156
+ "description": "RuleRemovalChangeRequest, passed in JSON format\n\nRequired fields: You must include a devices field, with a single device listed.\nMultiple devices are not supported.",
157
+ "required": true,
158
+ "schema": {
159
+ "$ref": "#/definitions/RuleRemovalChangeRequest"
160
+ }
161
+ }],
162
+ "responses": {
163
+ "200": {
164
+ "description": "Rule Removal Change Request created",
165
+ "schema": {
166
+ "$ref": "#/definitions/Response"
167
+ }
168
+ },
169
+ "400": {
170
+ "description": "Input validation failure",
171
+ "schema": {
172
+ "$ref": "#/definitions/Response"
173
+ }
174
+ },
175
+ "403": {
176
+ "description": "Authentication failure",
177
+ "schema": {
178
+ "$ref": "#/definitions/Response"
179
+ }
180
+ }
181
+ },
182
+ "deprecated": false
183
+ }
184
+ },
185
+ "/change-requests/traffic": {
186
+ "post": {
187
+ "tags": ["traffic-change-request-external-controller"],
188
+ "summary": "Create Traffic Change request",
189
+ "operationId": "createTrafficChangeRequestUsingPOST",
190
+ "consumes": ["application/json"],
191
+ "produces": ["*/*"],
192
+ "parameters": [{
193
+ "in": "body",
194
+ "name": "trafficChangeRequest",
195
+ "description": "TrafficChangeRequest, passed in JSON format",
196
+ "required": true,
197
+ "schema": {
198
+ "$ref": "#/definitions/TrafficChangeRequest"
199
+ }
200
+ }],
201
+ "responses": {
202
+ "200": {
203
+ "description": "OK",
204
+ "schema": {
205
+ "$ref": "#/definitions/Response"
206
+ }
207
+ }
208
+ },
209
+ "deprecated": false
210
+ }
211
+ },
212
+ "/change-requests/traffic/{changeRequestId}": {
213
+ "get": {
214
+ "tags": ["traffic-change-request-external-controller"],
215
+ "summary": "Get Ticket details by change request id number",
216
+ "operationId": "getTicketUsingGET",
217
+ "produces": ["*/*"],
218
+ "parameters": [{
219
+ "name": "changeRequestId",
220
+ "in": "path",
221
+ "description": "Id of the Change Request",
222
+ "required": true,
223
+ "type": "integer",
224
+ "format": "int64"
225
+ }],
226
+ "responses": {
227
+ "200": {
228
+ "description": "OK",
229
+ "schema": {
230
+ "$ref": "#/definitions/TrafficChangeRequestResponse"
231
+ }
232
+ }
233
+ },
234
+ "deprecated": false
235
+ }
236
+ },
237
+ "/change-requests/traffic/{changeRequestId}/fields": {
238
+ "put": {
239
+ "tags": ["traffic-change-request-external-controller"],
240
+ "summary": "Update Traffic Change request's custom fields",
241
+ "operationId": "updateTrafficChangeRequestCustomFieldsUsingPUT",
242
+ "consumes": ["application/json"],
243
+ "produces": ["*/*"],
244
+ "parameters": [{
245
+ "name": "changeRequestId",
246
+ "in": "path",
247
+ "description": "Id of the Change request",
248
+ "required": true,
249
+ "type": "integer",
250
+ "format": "int64"
251
+ }, {
252
+ "in": "body",
253
+ "name": "trafficChangeRequestFields",
254
+ "description": "List of fields, passed in JSON format",
255
+ "required": true,
256
+ "schema": {
257
+ "type": "array",
258
+ "items": {
259
+ "$ref": "#/definitions/Fields"
260
+ }
261
+ }
262
+ }],
263
+ "responses": {
264
+ "200": {
265
+ "description": "OK",
266
+ "schema": {
267
+ "$ref": "#/definitions/Response"
268
+ }
269
+ }
270
+ },
271
+ "deprecated": false
272
+ }
273
+ },
274
+ "/change-requests/traffic/{changeRequestId}/work-order/implement": {
275
+ "post": {
276
+ "tags": ["active-change-external-controller"],
277
+ "summary": "Implement work-order recommendations of the given change request, using ActiveChange",
278
+ "operationId": "calculateActiveChangeUsingPOST",
279
+ "consumes": ["application/json"],
280
+ "produces": ["application/json"],
281
+ "parameters": [{
282
+ "name": "changeRequestId",
283
+ "in": "path",
284
+ "description": "changeRequestId",
285
+ "required": true,
286
+ "type": "integer",
287
+ "format": "int64"
288
+ }],
289
+ "responses": {
290
+ "200": {
291
+ "description": "Active change was triggered",
292
+ "schema": {
293
+ "$ref": "#/definitions/Response"
294
+ }
295
+ },
296
+ "400": {
297
+ "description": "Input validation failure",
298
+ "schema": {
299
+ "$ref": "#/definitions/Response"
300
+ }
301
+ },
302
+ "403": {
303
+ "description": "Authentication failure",
304
+ "schema": {
305
+ "$ref": "#/definitions/Response"
306
+ }
307
+ }
308
+ },
309
+ "deprecated": false
310
+ }
311
+ },
312
+ "/change-requests/traffic/{changeRequestId}/work-order/implementation/result": {
313
+ "get": {
314
+ "tags": ["active-change-external-controller"],
315
+ "summary": "Get ActiveChange results of the given change request",
316
+ "operationId": "getActiveChangeStatusUsingGET",
317
+ "produces": ["application/json"],
318
+ "parameters": [{
319
+ "name": "changeRequestId",
320
+ "in": "path",
321
+ "description": "changeRequestId",
322
+ "required": true,
323
+ "type": "integer",
324
+ "format": "int64"
325
+ }],
326
+ "responses": {
327
+ "200": {
328
+ "description": "Active change returns status",
329
+ "schema": {
330
+ "$ref": "#/definitions/Response"
331
+ }
332
+ },
333
+ "400": {
334
+ "description": "Input validation failure",
335
+ "schema": {
336
+ "$ref": "#/definitions/Response"
337
+ }
338
+ },
339
+ "403": {
340
+ "description": "Authentication failure",
341
+ "schema": {
342
+ "$ref": "#/definitions/Response"
343
+ }
344
+ }
345
+ },
346
+ "deprecated": false
347
+ }
348
+ },
349
+ "/request/object": {
350
+ "post": {
351
+ "tags": ["object-change-request-external-controller"],
352
+ "summary": "Create Object Change request",
353
+ "operationId": "createObjectChangeRequestUsingPOST",
354
+ "consumes": ["application/json"],
355
+ "produces": ["application/json;charset=UTF-8"],
356
+ "parameters": [{
357
+ "in": "body",
358
+ "name": "objectChangeRequestDetails",
359
+ "description": "ObjectChangeRequestDetails, passed in JSON format",
360
+ "required": true,
361
+ "schema": {
362
+ "$ref": "#/definitions/ObjectChangeRequestDetails"
363
+ }
364
+ }],
365
+ "responses": {
366
+ "200": {
367
+ "description": "OK",
368
+ "schema": {
369
+ "$ref": "#/definitions/Response"
370
+ }
371
+ }
372
+ },
373
+ "deprecated": false
374
+ }
375
+ },
376
+ "/savedsearch": {
377
+ "get": {
378
+ "tags": ["saved-search-controller"],
379
+ "summary": "Find Saved Search results by name",
380
+ "operationId": "getSavedSearchByNameProxyUsingGET",
381
+ "produces": ["application/json;charset=UTF-8"],
382
+ "parameters": [{
383
+ "name": "savedSearchName",
384
+ "in": "query",
385
+ "description": "Name of Saved Search",
386
+ "required": true,
387
+ "type": "string",
388
+ "allowEmptyValue": false
389
+ }],
390
+ "responses": {
391
+ "200": {
392
+ "description": "OK",
393
+ "schema": {
394
+ "$ref": "#/definitions/Response"
395
+ }
396
+ }
397
+ },
398
+ "deprecated": false
399
+ }
400
+ },
401
+ "/session": {
402
+ "get": {
403
+ "tags": ["session-external-controller"],
404
+ "summary": "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.",
405
+ "operationId": "verifySessionStatusUsingGET",
406
+ "produces": ["application/json"],
407
+ "responses": {
408
+ "200": {
409
+ "description": "OK",
410
+ "schema": {
411
+ "$ref": "#/definitions/SessionRespose"
412
+ }
413
+ }
414
+ },
415
+ "deprecated": false
416
+ }
417
+ },
418
+ "/templates": {
419
+ "get": {
420
+ "tags": ["request-template-external-controller"],
421
+ "summary": "List all permitted request templates",
422
+ "operationId": "getTemplatesUsingGET",
423
+ "produces": ["*/*"],
424
+ "responses": {
425
+ "200": {
426
+ "description": "OK",
427
+ "schema": {
428
+ "$ref": "#/definitions/ResponseOfListOfRequestTemplateData"
429
+ }
430
+ }
431
+ },
432
+ "deprecated": false
433
+ }
434
+ }
435
+ },
436
+ "definitions": {
437
+ "Action": {
438
+ "type": "object",
439
+ "discriminator": "action",
440
+ "properties": {
441
+ "devices": {
442
+ "type": "array",
443
+ "items": {
444
+ "type": "string"
445
+ }
446
+ },
447
+ "lineOrder": {
448
+ "type": "integer",
449
+ "format": "int32"
450
+ },
451
+ "name": {
452
+ "type": "string"
453
+ },
454
+ "objectContainers": {
455
+ "type": "array",
456
+ "items": {
457
+ "type": "integer",
458
+ "format": "int64"
459
+ }
460
+ },
461
+ "type": {
462
+ "type": "string",
463
+ "enum": ["network", "service"]
464
+ },
465
+ "valuableServiceObject": {
466
+ "type": "boolean"
467
+ }
468
+ },
469
+ "title": "Action"
470
+ },
471
+ "AddObjectsToGroup": {
472
+ "title": "AddObjectsToGroup",
473
+ "properties": {
474
+ "devices": {
475
+ "type": "array",
476
+ "items": {
477
+ "type": "string"
478
+ }
479
+ },
480
+ "lineOrder": {
481
+ "type": "integer",
482
+ "format": "int32"
483
+ },
484
+ "name": {
485
+ "type": "string"
486
+ },
487
+ "objectContainers": {
488
+ "type": "array",
489
+ "items": {
490
+ "type": "integer",
491
+ "format": "int64"
492
+ }
493
+ },
494
+ "type": {
495
+ "type": "string",
496
+ "enum": ["network", "service"]
497
+ },
498
+ "valuableServiceObject": {
499
+ "type": "boolean"
500
+ },
501
+ "values": {
502
+ "type": "array",
503
+ "items": {
504
+ "type": "string"
505
+ }
506
+ }
507
+ },
508
+ "allOf": [{
509
+ "$ref": "#/definitions/Action"
510
+ }, {
511
+ "type": "object",
512
+ "properties": {
513
+ "devices": {
514
+ "type": "array",
515
+ "items": {
516
+ "type": "string"
517
+ }
518
+ },
519
+ "lineOrder": {
520
+ "type": "integer",
521
+ "format": "int32"
522
+ },
523
+ "name": {
524
+ "type": "string"
525
+ },
526
+ "objectContainers": {
527
+ "type": "array",
528
+ "items": {
529
+ "type": "integer",
530
+ "format": "int64"
531
+ }
532
+ },
533
+ "type": {
534
+ "type": "string",
535
+ "enum": ["network", "service"]
536
+ },
537
+ "valuableServiceObject": {
538
+ "type": "boolean"
539
+ },
540
+ "values": {
541
+ "type": "array",
542
+ "items": {
543
+ "type": "string"
544
+ }
545
+ }
546
+ },
547
+ "title": "AddObjectsToGroup"
548
+ }]
549
+ },
550
+ "AddressTrafficFieldDetails": {
551
+ "type": "object",
552
+ "properties": {
553
+ "items": {
554
+ "type": "array",
555
+ "items": {
556
+ "$ref": "#/definitions/AddressTrafficItemDetails"
557
+ }
558
+ }
559
+ },
560
+ "title": "AddressTrafficFieldDetails"
561
+ },
562
+ "AddressTrafficItemDetails": {
563
+ "type": "object",
564
+ "properties": {
565
+ "address": {
566
+ "type": "string",
567
+ "example": "1.1.1.1"
568
+ },
569
+ "fields": {
570
+ "type": "array",
571
+ "items": {
572
+ "$ref": "#/definitions/Fields"
573
+ }
574
+ }
575
+ },
576
+ "title": "AddressTrafficItemDetails"
577
+ },
578
+ "AuthenticationData": {
579
+ "type": "object",
580
+ "required": ["password", "username"],
581
+ "properties": {
582
+ "username": {
583
+ "type": "string",
584
+ "example": "admin",
585
+ "description": "User name"
586
+ },
587
+ "password": {
588
+ "type": "string",
589
+ "example": "pass",
590
+ "description": "User password"
591
+ },
592
+ "domain": {
593
+ "type": "string",
594
+ "example": 0,
595
+ "description": "Domain id"
596
+ }
597
+ },
598
+ "title": "AuthenticationData"
599
+ },
600
+ "Create": {
601
+ "title": "Create",
602
+ "properties": {
603
+ "devices": {
604
+ "type": "array",
605
+ "items": {
606
+ "type": "string"
607
+ }
608
+ },
609
+ "group": {
610
+ "type": "boolean"
611
+ },
612
+ "isGroup": {
613
+ "type": "boolean"
614
+ },
615
+ "lineOrder": {
616
+ "type": "integer",
617
+ "format": "int32"
618
+ },
619
+ "name": {
620
+ "type": "string"
621
+ },
622
+ "objectContainers": {
623
+ "type": "array",
624
+ "items": {
625
+ "type": "integer",
626
+ "format": "int64"
627
+ }
628
+ },
629
+ "type": {
630
+ "type": "string",
631
+ "enum": ["network", "service"]
632
+ },
633
+ "valuableServiceObject": {
634
+ "type": "boolean"
635
+ },
636
+ "values": {
637
+ "type": "array",
638
+ "items": {
639
+ "type": "string"
640
+ }
641
+ }
642
+ },
643
+ "allOf": [{
644
+ "$ref": "#/definitions/Action"
645
+ }, {
646
+ "type": "object",
647
+ "properties": {
648
+ "devices": {
649
+ "type": "array",
650
+ "items": {
651
+ "type": "string"
652
+ }
653
+ },
654
+ "group": {
655
+ "type": "boolean"
656
+ },
657
+ "isGroup": {
658
+ "type": "boolean"
659
+ },
660
+ "lineOrder": {
661
+ "type": "integer",
662
+ "format": "int32"
663
+ },
664
+ "name": {
665
+ "type": "string"
666
+ },
667
+ "objectContainers": {
668
+ "type": "array",
669
+ "items": {
670
+ "type": "integer",
671
+ "format": "int64"
672
+ }
673
+ },
674
+ "type": {
675
+ "type": "string",
676
+ "enum": ["network", "service"]
677
+ },
678
+ "valuableServiceObject": {
679
+ "type": "boolean"
680
+ },
681
+ "values": {
682
+ "type": "array",
683
+ "items": {
684
+ "type": "string"
685
+ }
686
+ }
687
+ },
688
+ "title": "Create"
689
+ }]
690
+ },
691
+ "Delete": {
692
+ "title": "Delete",
693
+ "properties": {
694
+ "devices": {
695
+ "type": "array",
696
+ "items": {
697
+ "type": "string"
698
+ }
699
+ },
700
+ "lineOrder": {
701
+ "type": "integer",
702
+ "format": "int32"
703
+ },
704
+ "name": {
705
+ "type": "string"
706
+ },
707
+ "objectContainers": {
708
+ "type": "array",
709
+ "items": {
710
+ "type": "integer",
711
+ "format": "int64"
712
+ }
713
+ },
714
+ "type": {
715
+ "type": "string",
716
+ "enum": ["network", "service"]
717
+ },
718
+ "valuableServiceObject": {
719
+ "type": "boolean"
720
+ }
721
+ },
722
+ "allOf": [{
723
+ "$ref": "#/definitions/Action"
724
+ }, {
725
+ "type": "object",
726
+ "properties": {
727
+ "devices": {
728
+ "type": "array",
729
+ "items": {
730
+ "type": "string"
731
+ }
732
+ },
733
+ "lineOrder": {
734
+ "type": "integer",
735
+ "format": "int32"
736
+ },
737
+ "name": {
738
+ "type": "string"
739
+ },
740
+ "objectContainers": {
741
+ "type": "array",
742
+ "items": {
743
+ "type": "integer",
744
+ "format": "int64"
745
+ }
746
+ },
747
+ "type": {
748
+ "type": "string",
749
+ "enum": ["network", "service"]
750
+ },
751
+ "valuableServiceObject": {
752
+ "type": "boolean"
753
+ }
754
+ },
755
+ "title": "Delete"
756
+ }]
757
+ },
758
+ "Field": {
759
+ "type": "object",
760
+ "properties": {
761
+ "name": {
762
+ "type": "string",
763
+ "example": "field name"
764
+ },
765
+ "values": {
766
+ "type": "array",
767
+ "example": ["field value 1", "field value 2"],
768
+ "items": {
769
+ "type": "string"
770
+ }
771
+ }
772
+ },
773
+ "title": "Field"
774
+ },
775
+ "Fields": {
776
+ "type": "object",
777
+ "properties": {
778
+ "name": {
779
+ "type": "string",
780
+ "example": "custom field name"
781
+ },
782
+ "values": {
783
+ "type": "array",
784
+ "example": ["custom field value 1", "custom field value 2"],
785
+ "items": {
786
+ "type": "string"
787
+ }
788
+ }
789
+ },
790
+ "title": "Fields"
791
+ },
792
+ "MessageDetails": {
793
+ "type": "object",
794
+ "properties": {
795
+ "code": {
796
+ "type": "string"
797
+ },
798
+ "message": {
799
+ "type": "string"
800
+ }
801
+ },
802
+ "title": "MessageDetails"
803
+ },
804
+ "NameTrafficFieldDetails": {
805
+ "type": "object",
806
+ "properties": {
807
+ "items": {
808
+ "type": "array",
809
+ "items": {
810
+ "$ref": "#/definitions/NameTrafficItemDetails"
811
+ }
812
+ }
813
+ },
814
+ "title": "NameTrafficFieldDetails"
815
+ },
816
+ "NameTrafficItemDetails": {
817
+ "type": "object",
818
+ "properties": {
819
+ "name": {
820
+ "type": "string",
821
+ "example": "name to match"
822
+ },
823
+ "fields": {
824
+ "type": "array",
825
+ "items": {
826
+ "$ref": "#/definitions/Fields"
827
+ }
828
+ }
829
+ },
830
+ "title": "NameTrafficItemDetails"
831
+ },
832
+ "Nat": {
833
+ "type": "object",
834
+ "properties": {
835
+ "source": {
836
+ "type": "array",
837
+ "items": {
838
+ "type": "string"
839
+ }
840
+ },
841
+ "destination": {
842
+ "type": "array",
843
+ "items": {
844
+ "type": "string"
845
+ }
846
+ },
847
+ "port": {
848
+ "type": "array",
849
+ "items": {
850
+ "type": "string"
851
+ }
852
+ },
853
+ "type": {
854
+ "type": "string",
855
+ "enum": ["Static", "Dynamic", "None"]
856
+ }
857
+ },
858
+ "title": "Nat"
859
+ },
860
+ "NatDetails": {
861
+ "type": "object",
862
+ "properties": {
863
+ "source": {
864
+ "type": "array",
865
+ "items": {
866
+ "type": "string"
867
+ }
868
+ },
869
+ "destination": {
870
+ "type": "array",
871
+ "items": {
872
+ "type": "string"
873
+ }
874
+ },
875
+ "port": {
876
+ "type": "array",
877
+ "items": {
878
+ "type": "string"
879
+ }
880
+ },
881
+ "type": {
882
+ "type": "string",
883
+ "example": "Static/Dynamic",
884
+ "enum": ["Static", "Dynamic", "None"]
885
+ }
886
+ },
887
+ "title": "NatDetails"
888
+ },
889
+ "ObjectChangeRequestDetails": {
890
+ "type": "object",
891
+ "required": ["devices", "fields", "requestedActions", "template"],
892
+ "properties": {
893
+ "template": {
894
+ "type": "string"
895
+ },
896
+ "fields": {
897
+ "type": "array",
898
+ "items": {
899
+ "$ref": "#/definitions/Fields"
900
+ }
901
+ },
902
+ "subject": {
903
+ "type": "string"
904
+ },
905
+ "cc": {
906
+ "type": "array",
907
+ "items": {
908
+ "type": "string"
909
+ }
910
+ },
911
+ "description": {
912
+ "type": "string"
913
+ },
914
+ "devices": {
915
+ "type": "array",
916
+ "items": {
917
+ "type": "string"
918
+ }
919
+ },
920
+ "due": {
921
+ "type": "string"
922
+ },
923
+ "expire": {
924
+ "type": "string"
925
+ },
926
+ "externalId": {
927
+ "type": "string"
928
+ },
929
+ "owner": {
930
+ "type": "string"
931
+ },
932
+ "priority": {
933
+ "type": "string"
934
+ },
935
+ "refersTo": {
936
+ "type": "array",
937
+ "items": {
938
+ "type": "string"
939
+ }
940
+ },
941
+ "referredBy": {
942
+ "type": "array",
943
+ "items": {
944
+ "type": "string"
945
+ }
946
+ },
947
+ "requestor": {
948
+ "type": "string"
949
+ },
950
+ "requestedActions": {
951
+ "type": "array",
952
+ "example": [{
953
+ "action": "create",
954
+ "name": "string",
955
+ "type": "network/service",
956
+ "isGroup": "true/false",
957
+ "values": ["string 1", "string 2"]
958
+ }, {
959
+ "action": "delete",
960
+ "name": "string",
961
+ "type": "network/service"
962
+ }, {
963
+ "action": "addObjectsToGroup",
964
+ "name": "string",
965
+ "type": "network/service",
966
+ "values": ["string 1", "string 2"]
967
+ }, {
968
+ "action": "removeObjectsFromGroup",
969
+ "name": "string",
970
+ "type": "network/service",
971
+ "values": ["string 1", "string 2"]
972
+ }, {
973
+ "action": "replaceContent",
974
+ "name": "string",
975
+ "type": "network/service",
976
+ "values": ["string 1", "string 2"]
977
+ }],
978
+ "description": "Requested actions",
979
+ "items": {
980
+ "$ref": "#/definitions/Action"
981
+ }
982
+ },
983
+ "objectContainerLevel": {
984
+ "type": "string",
985
+ "example": "Lowest/Highest/Automatic",
986
+ "description": "Object container level",
987
+ "enum": ["Lowest", "Highest", "Automatic", "Invalid"]
988
+ }
989
+ },
990
+ "title": "ObjectChangeRequestDetails"
991
+ },
992
+ "RemoveObjectsFromGroup": {
993
+ "title": "RemoveObjectsFromGroup",
994
+ "properties": {
995
+ "devices": {
996
+ "type": "array",
997
+ "items": {
998
+ "type": "string"
999
+ }
1000
+ },
1001
+ "lineOrder": {
1002
+ "type": "integer",
1003
+ "format": "int32"
1004
+ },
1005
+ "name": {
1006
+ "type": "string"
1007
+ },
1008
+ "objectContainers": {
1009
+ "type": "array",
1010
+ "items": {
1011
+ "type": "integer",
1012
+ "format": "int64"
1013
+ }
1014
+ },
1015
+ "type": {
1016
+ "type": "string",
1017
+ "enum": ["network", "service"]
1018
+ },
1019
+ "valuableServiceObject": {
1020
+ "type": "boolean"
1021
+ },
1022
+ "values": {
1023
+ "type": "array",
1024
+ "items": {
1025
+ "type": "string"
1026
+ }
1027
+ }
1028
+ },
1029
+ "allOf": [{
1030
+ "$ref": "#/definitions/Action"
1031
+ }, {
1032
+ "type": "object",
1033
+ "properties": {
1034
+ "devices": {
1035
+ "type": "array",
1036
+ "items": {
1037
+ "type": "string"
1038
+ }
1039
+ },
1040
+ "lineOrder": {
1041
+ "type": "integer",
1042
+ "format": "int32"
1043
+ },
1044
+ "name": {
1045
+ "type": "string"
1046
+ },
1047
+ "objectContainers": {
1048
+ "type": "array",
1049
+ "items": {
1050
+ "type": "integer",
1051
+ "format": "int64"
1052
+ }
1053
+ },
1054
+ "type": {
1055
+ "type": "string",
1056
+ "enum": ["network", "service"]
1057
+ },
1058
+ "valuableServiceObject": {
1059
+ "type": "boolean"
1060
+ },
1061
+ "values": {
1062
+ "type": "array",
1063
+ "items": {
1064
+ "type": "string"
1065
+ }
1066
+ }
1067
+ },
1068
+ "title": "RemoveObjectsFromGroup"
1069
+ }]
1070
+ },
1071
+ "ReplaceContent": {
1072
+ "title": "ReplaceContent",
1073
+ "properties": {
1074
+ "devices": {
1075
+ "type": "array",
1076
+ "items": {
1077
+ "type": "string"
1078
+ }
1079
+ },
1080
+ "lineOrder": {
1081
+ "type": "integer",
1082
+ "format": "int32"
1083
+ },
1084
+ "name": {
1085
+ "type": "string"
1086
+ },
1087
+ "objectContainers": {
1088
+ "type": "array",
1089
+ "items": {
1090
+ "type": "integer",
1091
+ "format": "int64"
1092
+ }
1093
+ },
1094
+ "type": {
1095
+ "type": "string",
1096
+ "enum": ["network", "service"]
1097
+ },
1098
+ "valuableServiceObject": {
1099
+ "type": "boolean"
1100
+ },
1101
+ "values": {
1102
+ "type": "array",
1103
+ "items": {
1104
+ "type": "string"
1105
+ }
1106
+ }
1107
+ },
1108
+ "allOf": [{
1109
+ "$ref": "#/definitions/Action"
1110
+ }, {
1111
+ "type": "object",
1112
+ "properties": {
1113
+ "devices": {
1114
+ "type": "array",
1115
+ "items": {
1116
+ "type": "string"
1117
+ }
1118
+ },
1119
+ "lineOrder": {
1120
+ "type": "integer",
1121
+ "format": "int32"
1122
+ },
1123
+ "name": {
1124
+ "type": "string"
1125
+ },
1126
+ "objectContainers": {
1127
+ "type": "array",
1128
+ "items": {
1129
+ "type": "integer",
1130
+ "format": "int64"
1131
+ }
1132
+ },
1133
+ "type": {
1134
+ "type": "string",
1135
+ "enum": ["network", "service"]
1136
+ },
1137
+ "valuableServiceObject": {
1138
+ "type": "boolean"
1139
+ },
1140
+ "values": {
1141
+ "type": "array",
1142
+ "items": {
1143
+ "type": "string"
1144
+ }
1145
+ }
1146
+ },
1147
+ "title": "ReplaceContent"
1148
+ }]
1149
+ },
1150
+ "RequestTemplateData": {
1151
+ "type": "object",
1152
+ "properties": {
1153
+ "description": {
1154
+ "type": "string"
1155
+ },
1156
+ "enabled": {
1157
+ "type": "boolean"
1158
+ },
1159
+ "id": {
1160
+ "type": "integer",
1161
+ "format": "int32"
1162
+ },
1163
+ "name": {
1164
+ "type": "string"
1165
+ },
1166
+ "type": {
1167
+ "type": "string",
1168
+ "enum": ["Generic Change", "Object Change", "Object Change Multi Device", "Request Recertification", "Rule Modification", "Rule Removal", "Traffic Change", "Traffic Change IPv6", "Unknown", "Web Filter Change"]
1169
+ }
1170
+ },
1171
+ "title": "RequestTemplateData"
1172
+ },
1173
+ "Response": {
1174
+ "type": "object",
1175
+ "properties": {
1176
+ "data": {
1177
+ "type": "object"
1178
+ },
1179
+ "messages": {
1180
+ "type": "array",
1181
+ "items": {
1182
+ "$ref": "#/definitions/MessageDetails"
1183
+ }
1184
+ },
1185
+ "status": {
1186
+ "type": "string",
1187
+ "enum": ["Success", "Failure"]
1188
+ }
1189
+ },
1190
+ "title": "Response"
1191
+ },
1192
+ "ResponseOfListOfRequestTemplateData": {
1193
+ "type": "object",
1194
+ "properties": {
1195
+ "data": {
1196
+ "type": "array",
1197
+ "items": {
1198
+ "$ref": "#/definitions/RequestTemplateData"
1199
+ }
1200
+ },
1201
+ "messages": {
1202
+ "type": "array",
1203
+ "items": {
1204
+ "$ref": "#/definitions/MessageDetails"
1205
+ }
1206
+ },
1207
+ "status": {
1208
+ "type": "string",
1209
+ "enum": ["Success", "Failure"]
1210
+ }
1211
+ },
1212
+ "title": "ResponseOfListOfRequestTemplateData"
1213
+ },
1214
+ "RuleRemovalChangeRequest": {
1215
+ "type": "object",
1216
+ "required": ["fields", "requestActions", "template"],
1217
+ "properties": {
1218
+ "template": {
1219
+ "type": "string"
1220
+ },
1221
+ "fields": {
1222
+ "type": "array",
1223
+ "items": {
1224
+ "$ref": "#/definitions/Fields"
1225
+ }
1226
+ },
1227
+ "requestActions": {
1228
+ "type": "array",
1229
+ "description": "Request actions",
1230
+ "items": {
1231
+ "$ref": "#/definitions/RuleRemovalRequestedUnit"
1232
+ }
1233
+ }
1234
+ },
1235
+ "title": "RuleRemovalChangeRequest"
1236
+ },
1237
+ "RuleRemovalRequestedUnit": {
1238
+ "type": "object",
1239
+ "properties": {
1240
+ "action": {
1241
+ "type": "string",
1242
+ "enum": ["remove", "disable"]
1243
+ },
1244
+ "ruleId": {
1245
+ "type": "string"
1246
+ }
1247
+ },
1248
+ "title": "RuleRemovalRequestedUnit"
1249
+ },
1250
+ "ServiceTrafficFieldDetails": {
1251
+ "type": "object",
1252
+ "properties": {
1253
+ "items": {
1254
+ "type": "array",
1255
+ "items": {
1256
+ "$ref": "#/definitions/ServiceTrafficItemDetails"
1257
+ }
1258
+ }
1259
+ },
1260
+ "title": "ServiceTrafficFieldDetails"
1261
+ },
1262
+ "ServiceTrafficItemDetails": {
1263
+ "type": "object",
1264
+ "properties": {
1265
+ "service": {
1266
+ "type": "string",
1267
+ "example": "tcp/80"
1268
+ },
1269
+ "fields": {
1270
+ "type": "array",
1271
+ "items": {
1272
+ "$ref": "#/definitions/Fields"
1273
+ }
1274
+ }
1275
+ },
1276
+ "title": "ServiceTrafficItemDetails"
1277
+ },
1278
+ "SessionRespose": {
1279
+ "type": "object",
1280
+ "properties": {
1281
+ "message": {
1282
+ "$ref": "#/definitions/MessageDetails"
1283
+ },
1284
+ "valid": {
1285
+ "type": "boolean"
1286
+ }
1287
+ },
1288
+ "title": "SessionRespose"
1289
+ },
1290
+ "TrafficChangeRequest": {
1291
+ "type": "object",
1292
+ "required": ["fields", "template", "traffic"],
1293
+ "properties": {
1294
+ "template": {
1295
+ "type": "string"
1296
+ },
1297
+ "fields": {
1298
+ "type": "array",
1299
+ "items": {
1300
+ "$ref": "#/definitions/Fields"
1301
+ }
1302
+ },
1303
+ "traffic": {
1304
+ "type": "array",
1305
+ "description": "traffic",
1306
+ "items": {
1307
+ "$ref": "#/definitions/TrafficLineDetails"
1308
+ }
1309
+ }
1310
+ },
1311
+ "title": "TrafficChangeRequest"
1312
+ },
1313
+ "TrafficChangeRequestData": {
1314
+ "type": "object",
1315
+ "properties": {
1316
+ "id": {
1317
+ "type": "integer",
1318
+ "format": "int64"
1319
+ },
1320
+ "subChangeRequests": {
1321
+ "type": "array",
1322
+ "description": "sub change request ids",
1323
+ "items": {
1324
+ "type": "integer",
1325
+ "format": "int64"
1326
+ }
1327
+ },
1328
+ "fields": {
1329
+ "type": "array",
1330
+ "description": "change request fields",
1331
+ "items": {
1332
+ "$ref": "#/definitions/Field"
1333
+ }
1334
+ },
1335
+ "originalTraffic": {
1336
+ "type": "array",
1337
+ "description": "original traffic requested by creator; available only for parent change request",
1338
+ "items": {
1339
+ "$ref": "#/definitions/TrafficLine"
1340
+ }
1341
+ },
1342
+ "plannedTraffic": {
1343
+ "type": "array",
1344
+ "description": "traffic that is planned to implement",
1345
+ "items": {
1346
+ "$ref": "#/definitions/TrafficLine"
1347
+ }
1348
+ }
1349
+ },
1350
+ "title": "TrafficChangeRequestData"
1351
+ },
1352
+ "TrafficChangeRequestResponse": {
1353
+ "type": "object",
1354
+ "properties": {
1355
+ "data": {
1356
+ "$ref": "#/definitions/TrafficChangeRequestData"
1357
+ },
1358
+ "messages": {
1359
+ "type": "array",
1360
+ "items": {
1361
+ "$ref": "#/definitions/MessageDetails"
1362
+ }
1363
+ },
1364
+ "status": {
1365
+ "type": "string",
1366
+ "enum": ["Success", "Failure"]
1367
+ }
1368
+ },
1369
+ "title": "TrafficChangeRequestResponse"
1370
+ },
1371
+ "TrafficField": {
1372
+ "type": "object",
1373
+ "properties": {
1374
+ "items": {
1375
+ "type": "array",
1376
+ "items": {
1377
+ "$ref": "#/definitions/TrafficItem"
1378
+ }
1379
+ }
1380
+ },
1381
+ "title": "TrafficField"
1382
+ },
1383
+ "TrafficItem": {
1384
+ "type": "object",
1385
+ "properties": {
1386
+ "value": {
1387
+ "type": "string"
1388
+ },
1389
+ "fields": {
1390
+ "type": "array",
1391
+ "description": "custom fields related to the item",
1392
+ "items": {
1393
+ "$ref": "#/definitions/Field"
1394
+ }
1395
+ }
1396
+ },
1397
+ "title": "TrafficItem"
1398
+ },
1399
+ "TrafficLine": {
1400
+ "type": "object",
1401
+ "properties": {
1402
+ "source": {
1403
+ "$ref": "#/definitions/TrafficField"
1404
+ },
1405
+ "destination": {
1406
+ "$ref": "#/definitions/TrafficField"
1407
+ },
1408
+ "service": {
1409
+ "$ref": "#/definitions/TrafficField"
1410
+ },
1411
+ "application": {
1412
+ "$ref": "#/definitions/TrafficField"
1413
+ },
1414
+ "user": {
1415
+ "$ref": "#/definitions/TrafficField"
1416
+ },
1417
+ "fields": {
1418
+ "type": "array",
1419
+ "items": {
1420
+ "$ref": "#/definitions/Field"
1421
+ }
1422
+ },
1423
+ "natDetails": {
1424
+ "$ref": "#/definitions/Nat"
1425
+ },
1426
+ "action": {
1427
+ "type": "string",
1428
+ "enum": ["Allow", "Drop"]
1429
+ }
1430
+ },
1431
+ "title": "TrafficLine"
1432
+ },
1433
+ "TrafficLineDetails": {
1434
+ "type": "object",
1435
+ "required": ["application", "destination", "fields", "natDetails", "service", "source", "user"],
1436
+ "properties": {
1437
+ "source": {
1438
+ "description": "source",
1439
+ "$ref": "#/definitions/AddressTrafficFieldDetails"
1440
+ },
1441
+ "destination": {
1442
+ "description": "destination",
1443
+ "$ref": "#/definitions/AddressTrafficFieldDetails"
1444
+ },
1445
+ "service": {
1446
+ "description": "service",
1447
+ "$ref": "#/definitions/ServiceTrafficFieldDetails"
1448
+ },
1449
+ "application": {
1450
+ "description": "application",
1451
+ "$ref": "#/definitions/NameTrafficFieldDetails"
1452
+ },
1453
+ "user": {
1454
+ "description": "user",
1455
+ "$ref": "#/definitions/NameTrafficFieldDetails"
1456
+ },
1457
+ "action": {
1458
+ "type": "string",
1459
+ "example": "Allow/Drop"
1460
+ },
1461
+ "natDetails": {
1462
+ "description": "nat details",
1463
+ "$ref": "#/definitions/NatDetails"
1464
+ },
1465
+ "fields": {
1466
+ "type": "array",
1467
+ "description": "fields",
1468
+ "items": {
1469
+ "$ref": "#/definitions/Fields"
1470
+ }
1471
+ }
1472
+ },
1473
+ "title": "TrafficLineDetails"
1474
+ }
1475
+ }
1476
+ }