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