emasser 3.10.0 → 3.12.0

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.
data/docs/features.md CHANGED
@@ -1,14 +1,14 @@
1
- # emasser CLI Features
1
+ # eMASSer CLI Features
2
2
 
3
3
  ## Environment Variables
4
- To facilitate setting the required environment variables the `emasser `CLI utilized the zero-dependency module to load these variables from a `.env` file.
4
+ To facilitate setting the required environment variables the `eMASSer `CLI utilized the zero-dependency module to load these variables from a `.env` file.
5
5
 
6
6
  ### Configuring the `.env` File
7
7
  An `.env-example` file is provided with the required and optional fields.
8
8
 
9
9
  Modify the `.env_example` as necessary and save it as a `.env` file.
10
10
 
11
- Place the file on the path where the `emasser` command is executed.
11
+ Place the file on the path where the `eMASSer` command is executed.
12
12
 
13
13
  ### Required and Optional Environment Variables
14
14
  The following environment variables are required:
@@ -25,7 +25,7 @@ The following environment variables are optional*:
25
25
  * EMASSER_VERIFY_SSL_HOST=`<verify host SSL - true or false (default true)>`
26
26
  * EMASSER_DEBUGGING=`<set debugging - true or false (default false)>`
27
27
  * EMASSER_CLI_DISPLAY_NULL=`<display null value fields - true or false (default true)>`
28
- * EMASSER_POCH_TO_DATETIME=`<convert epoch to data/time value - true or false (default false)>`
28
+ * EMASSER_EPOCH_TO_DATETIME=`<convert epoch to data/time value - true or false (default false)>`
29
29
 
30
30
  \* If not provided defaults are used
31
31
 
@@ -34,70 +34,143 @@ The proper format to set these variables in the `.env` files is as follows:
34
34
  export [VARIABLE_NAME]='value'
35
35
  ```
36
36
  ***NOTE***
37
- `emasser` requires authentication to an eMASS instance as well as authorization to use the eMASS API. This authentication and authorization is **not** a function of `emasser` and needs to be accomplished with the eMASS instances owner organization. Further information about eMASS credential requirements refer to [Defense Counterintelligence and Security Agency](https://www.dcsa.mil/is/emass/) about eMASS access.
37
+ `eMASSer` requires authentication to an eMASS instance as well as authorization to use the eMASS API. This authentication and authorization is **not** a function of `eMASSer` and needs to be accomplished with the eMASS instances owner organization. Further information about eMASS credential requirements refer to [Defense Counterintelligence and Security Agency](https://www.dcsa.mil/is/emass/) about eMASS access.
38
38
 
39
39
  ---
40
- ## Common emasser Endpoint Requests Information
40
+ ## Common eMASSer Endpoint Requests Information
41
41
  - To invoke any boolean parameters use --parameterName for TRUE and --no-parameterName for FALSE
42
- - The eMASS API provides the capability of updating multiple entries within several endpoints, however the `emasser` CLI, in some cases only supports updating one entry at the time.
43
-
44
- ## Invoking emasser CLI Commands
45
-
46
- The CLI invoke commands listed in this document shows them when executing from the source code (after a pull from GitHub). Please reference the [`emasser` README](https://mitre.github.io/emasser/) on how to invoke the CLI using other available executables (gem or docker).
47
-
48
- ## API Endpoints Provided
49
-
50
- ### GET
51
- * [/api](#get-test-connection)
52
- * [/api/system](#get-system)
53
- * [/api/systems](#get-systems)
54
- * [/api/systems/{systemId}](#get-system)
55
- * [/api/system-roles](#get-roles)
56
- * [/api/system-roles/{roleCategory}](#get-roles)
57
- * [/api/systems/{systemId}/controls](#get-controls)
58
- * [/api/systems/{systemId}/test-results](#get-testresults)
59
- * [/api/systems/{systemId}/poams](#get-poams)
60
- * [/api/systems/{systemId}/poams/{poamId}](#get-poams)
61
- * [/api/systems/{systemId}/poams/{poamId}/milestones](#get-milestones)
62
- * [/api/systems/{systemId}/poams/{poamId}/milestones/{milestoneId})](#get-milestones)
63
- * [/api/systems/{systemId}/artifacts](#get-artifacts)
64
- * [/api/systems/{systemId}/artifacts-export](#get-artifacts)
65
- * [/api/systems/{systemId}/approval/cac](#get-cac)
66
- * [/api/systems/{systemId}/approval/pac](#get-pac)
67
- * [/api/cmmc-assessments](#get-cmmc)
68
- * [/api/workflow-definitions](#get-workflow_definitions)
69
- * [/api/systems/{systemId}/workflow-instances](#get-workflow_instances)
70
- * [/api/dashboards/system-status-details](#get-dashboards)
71
- * [/api/dashboards/system-control-compliance-summary](#get-dashboards)
72
- * [/api/dashboards/system-security-controls-details](#get-dashboards)
73
- * [/api/dashboards/system-assessment-procedures-details](#get-dashboards)
74
- * [/api/dashboards/system-poam-summary](#get-dashboards)
75
- * [/api/dashboards/system-poam-details](#get-dashboards)
76
- * [/api/dashboards/system-artifacts-summary](#get-dashboards)
77
- * [/api/dashboards/system-artifacts-details](#get-dashboards)
78
- * [/api/dashboards/system-hardware-summary](#get-dashboards)
79
- * [/api/dashboards/system-hardware-details](#get-dashboards)
80
- * [/api/dashboards/system-sensor-hardware-summary](#get-dashboards)
81
- * [/api/dashboards/system-sensor-hardware-details](#get-dashboards)
82
- * [/api/dashboards/system-software-summary](#get-dashboards)
83
- * [/api/dashboards/system-software-details](#get-dashboards)
84
- * [/api/dashboards/system-ports-protocols-summary](#get-dashboards)
85
- * [/api/dashboards/system-ports-protocols-details](#get-dashboards)
86
- * [/api/dashboards/system-conmon-integration-status-summary](#get-dashboards)
87
- * [/api/dashboards/system-associations-details](#get-dashboards)
88
- * [/api/dashboards/user-system-assignments-details](#get-dashboards)
89
- * [/api/dashboards/system-privacy-summary](#get-dashboards)
90
- * [/api/dashboards/va-omb-fisma-saop-summary](#get-dashboards)
91
- * [/api/dashboards/va-system-aa-summary](#get-dashboards)
92
- * [/api/dashboards/va-system-a2-summary](#get-dashboards)
93
- * [/api/dashboards/va-system-pl-109-reporting-summary](#get-dashboards)
94
- * [/api/dashboards/va-system-fisma-inventory-summary](#get-dashboards)
95
- * [/api/dashboards/va-system-fisma-inventory-crypto-summary](#get-dashboards)
96
- * [/api/dashboards/va-system-threat-risks-summary](#get-dashboards)
97
- * [/api/dashboards/va-system-threat-sources-details](#get-dashboards)
98
- * [/api/dashboards/va-system-threat-architecture-details](#get-dashboards)
42
+ - The eMASS API provides the capability of updating multiple entries within several endpoints, however the `eMASSer` CLI, in some cases only supports updating one entry at the time.
43
+
44
+ ## Invoking eMASSer CLI Commands
45
+
46
+ The CLI invoke commands listed in this document shows them when executing from the source code (after a pull from GitHub). Please reference the [`eMASSer` README](https://mitre.github.io/emasser/) on how to invoke the CLI using other available executables (gem or docker).
47
+
48
+ ## GET Endpoints
49
+ #### Test Connection
50
+ * [/api](#get-test-connection)
51
+
52
+ #### System Endpoints
53
+ * [/api/system](#get-system)
54
+ * [/api/systems](#get-systems)
55
+ * [/api/systems/{systemId}](#get-system)
56
+
57
+ #### System Roles Endpoints
58
+ * [/api/system-roles](#get-roles)
59
+ * [/api/system-roles/{roleCategory}](#get-roles)
60
+
61
+ #### Controls Endpoint
62
+ * [/api/systems/{systemId}/controls](#get-controls)
63
+
64
+ #### Test Results Endpoint
65
+ * [/api/systems/{systemId}/test-results](#get-test_results)
66
+
67
+ #### POA&Ms Endpoints
68
+ * [/api/systems/{systemId}/poams](#get-poams)
69
+ * [/api/systems/{systemId}/poams/{poamId}](#get-poams)
70
+
71
+ #### Milestones Endpoints
72
+ * [/api/systems/{systemId}/poams/{poamId}/milestones](#get-milestones)
73
+ * [/api/systems/{systemId}/poams/{poamId}/milestones/{milestoneId})](#get-milestones)
74
+
75
+ #### Artifacts Endpoints
76
+ * [/api/systems/{systemId}/artifacts](#get-artifacts)
77
+ * [/api/systems/{systemId}/artifacts-export](#get-artifacts)
78
+
79
+ #### CAC Endpoint
80
+ * [/api/systems/{systemId}/approval/cac](#get-cac)
81
+
82
+ #### PAC Endpoint
83
+ * [/api/systems/{systemId}/approval/pac](#get-pac)
84
+
85
+ #### CMMC Assessment Endpoint
86
+ * [/api/cmmc-assessments](#get-cmmc)
87
+
88
+ #### Workflow Definition Endpoint
89
+ * [/api/workflow-definitions](#get-workflow_definitions)
90
+
91
+ #### Workflow Instances Endpoint
92
+ * [/api/systems/{systemId}/workflow-instances](#get-workflow_instances)
93
+
94
+ ### [Dashboards](#get-dashboards)
95
+
96
+ #### System Status Dashboard
97
+ * [/api/dashboards/system-status-details](#system-status-endpoint)
98
+
99
+ #### Enterprise Terms Conditions Dashboard
100
+ * [/api/dashboards/system-terms-conditions-summary](#system-terms-conditions-endpoints)
101
+ * [/api/dashboards/system-terms-conditions-details](#system-terms-conditions-endpoints)
102
+
103
+ ### Enterprise Security Controls Dashboard
104
+ * [/api/dashboards/system-control-compliance-summary](#enterprise-security-controls-endpoints)
105
+ * [/api/dashboards/system-security-controls-details](#enterprise-security-controls-endpoints)
106
+ * [/api/dashboards/system-assessment-procedures-details](#enterprise-security-controls-endpoints)
107
+
108
+ ### Enterprise POA&M Dashboard
109
+ * [/api/dashboards/system-poam-summary](#enterprise-poam-endpoints)
110
+ * [/api/dashboards/system-poam-details](#enterprise-poam-endpoints)
111
+
112
+ ### Enterprise Artifacts Dashboard
113
+ * [/api/dashboards/system-artifacts-summary](#enterprise-artifacts-endpoints)
114
+ * [/api/dashboards/system-artifacts-details](#enterprise-artifacts-endpoints)
115
+
116
+ ### Hardware Baseline Dashboard
117
+ * [/api/dashboards/system-hardware-summary](#hardware-baseline-endpoints)
118
+ * [/api/dashboards/system-hardware-details](#hardware-baseline-endpoints)
119
+
120
+ ### Enterprise Sensor-based Hardware Resources Dashboard
121
+ * [/api/dashboards/system-sensor-hardware-summary](#enterprise-sensor-based-hardware-resources-endpoints)
122
+ * [/api/dashboards/system-sensor-hardware-details](#enterprise-sensor-based-hardware-resources-endpoints)
123
+
124
+ ### Software Baseline Dashboard
125
+ * [/api/dashboards/system-software-summary](#software-baseline-endpoints)
126
+ * [/api/dashboards/system-software-details](#software-baseline-endpoints)
127
+
128
+ ### Enterprise Sensor-based Software Resources Dashboard
129
+ * [/api/dashboards/system-sensor-software-summary](#enterprise-sensor-based-software-resources-endpoints)
130
+ * [/api/dashboards/system-sensor-software-details](#enterprise-sensor-based-software-resources-endpoints)
131
+ * [/api/dashboards/system-sensor-software-counts](#enterprise-sensor-based-software-resources-endpoints)
132
+
133
+ ### Enterprise Vulnerability Dashboard
134
+ * [/api/dashboards/system-vulnerability-summary](#enterprise-vulnerability-endpoints)
135
+ * [/api/dashboards/system-device-findings-summary](#enterprise-vulnerability-endpoints)
136
+ * [/api/dashboards/system-device-findings-details](#enterprise-vulnerability-endpoints)
137
+
138
+ ### Ports and Protocols Dashboard
139
+ * [/api/dashboards/system-ports-protocols-summary](#ports-and-protocols-endpoints)
140
+ * [/api/dashboards/system-ports-protocols-details](#ports-and-protocols-endpoints)
141
+
142
+ ### System CONMON Integration Status Dashboard
143
+ * [/api/dashboards/system-conmon-integration-status-summary](#system-conmon-integration-status-endpoint)
144
+
145
+ ### System Associations Dashboard
146
+ * [/api/dashboards/system-associations-details](#system-associations-endpoint)
147
+
148
+ ### Users Dashboard
149
+ * [/api/dashboards/user-system-assignments-details](#users-endpoint)
150
+
151
+ ### Privacy Compliance Dashboard
152
+ * [/api/dashboards/system-privacy-summary](#privacy-compliance-endpoints)
153
+ * [/api/dashboards/va-omb-fisma-saop-summary](#privacy-compliance-endpoints)
154
+
155
+ ### System A&A Summary Dashboard
156
+ * [/api/dashboards/va-system-aa-summary](#system-aa-summary-endpoint)
157
+
158
+ ### System A2.0 Summary Dashboard
159
+ * [/api/dashboards/va-system-a2-summary](#system-a20-summary-endpoint)
160
+
161
+ ### System P.L. 109 Reporting Summary Dashboard
162
+ * [/api/dashboards/va-system-pl-109-reporting-summary](#system-pl-109-reporting-summary-endpoint)
163
+
164
+ ### FISMA Inventory Summary Dashboard
165
+ * [/api/dashboards/va-system-fisma-inventory-summary](#fisma-inventory-summary-endpoints)
166
+ * [/api/dashboards/va-system-fisma-inventory-crypto-summary](#fisma-inventory-summary-endpoints)
167
+
168
+ ### Threat Risks Dashboard
169
+ * [/api/dashboards/va-system-threat-risks-summary](#threat-risks-endpoints)
170
+ * [/api/dashboards/va-system-threat-sources-details](#threat-risks-endpoints)
171
+ * [/api/dashboards/va-system-threat-architecture-details](#threat-risks-endpoints)
99
172
 
100
- ### POST
173
+ ## POST Endpoints
101
174
  * [/api/systems/{systemId}/test-results](#post-test_results)
102
175
  * [/api/systems/{systemId}/poam](#post-poams)
103
176
  * [/api/systems/{systemId}/poam/{poamId}/milestones](#post-milestones)
@@ -108,18 +181,20 @@ The CLI invoke commands listed in this document shows them when executing from t
108
181
  * [/api/systems/{systemId}/cloud-resource-results](#post-cloud_resource)
109
182
  * [/api/systems/{systemId}/container-scan-results](#post-container)
110
183
 
111
- ### PUT
184
+ ## PUT Endpoints
112
185
  * [/api/systems/{systemId}/controls](#put-controls)
113
186
  * [/api/systems/{systemId}/poams](#put-poams)
114
187
  * [/api/systems/{systemId}/poams/{poamId}/milestones](#put-milestones)
115
188
  * [/api/systems/{systemId}/artifacts](#put-artifacts)
116
189
 
117
- ### DELETE
190
+ ## DELETE Endpoints
118
191
  * [/api/systems/{systemId}/poams](#delete-poams)
119
192
  * [/api/systems/{systemId}/poams/{poamId}/milestones](#delete-milestones)
120
193
  * [/api/systems/{systemId}/artifacts](#delete-artifacts)
194
+ * [/api/systems/{systemId}/cloud-resource-results](#delete-cloud-resource)
195
+ * [/api/systems/{systemId}/container-scan-results](#delete-container)
121
196
 
122
- ## Endpoints CLI help
197
+ # Endpoints CLI help
123
198
 
124
199
  Each CLI endpoint command has several layers of help.
125
200
  - Using `help` after a `get, put, post, or delete` command lists all available endpoint calls. The following command would list all available `GET` endpoints commands.
@@ -148,20 +223,21 @@ Each CLI endpoint command has several layers of help.
148
223
  ```bash
149
224
  $ bundle exec exe/emasser get help artifacts
150
225
  commands:
151
- emasser get artifacts export --filename=FILENAME --systemId=N # Get artifa...
152
- emasser get artifacts forSystem --systemId=N # Get all sy...
153
- emasser get artifacts help [COMMAND] # Describe s...
226
+ emasser get artifacts export -f, --filename=FILENAME -s, --systemId=N # Get artifa...
227
+ emasser get artifacts forSystem -s, --systemId=N # Get all sy...
228
+ emasser get artifacts help [COMMAND] # Describe s...
154
229
  ```
155
230
  - Using `help` after any command lists all available options. The following command would list all available options for the `get artifacts export` endpoint command.
156
231
  ```bash
157
232
  $ bundle exec exe/emasser get artifacts help export
158
233
  Usage:
159
- emasser get artifacts export --filename=FILENAME --systemId=N
234
+ emasser get artifacts export -f, --filename=FILENAME -s, --systemId=N
160
235
 
161
236
  Options:
162
- --systemId=N # A numeric value representing the system identification
163
- --filename=FILENAME # The artifact file name
164
- [--compress], [--no-compress] # BOOLEAN - true or false.
237
+ -s, --systemId=N # A numeric value representing the system identification
238
+ -f, --filename=FILENAME # The artifact file name
239
+ -C, [--compress], [--no-compress] # BOOLEAN - true or false.
240
+ -o, [--printToStdout=PRINTTOSTDOUT] # Output file content to terminal - not valid for zip files
165
241
  ```
166
242
  **The same format is applicable for POST, PUT and DELETE requests as well, however there may be additional help content**
167
243
 
@@ -177,7 +253,7 @@ The Test Connection endpoint provides the ability to verify connection to the we
177
253
  A return of success from the call indicates that the CLI can reach the configure server URL.
178
254
  References [Required Environment Variables](#required-environment-variables) for the necessary environment variables.
179
255
 
180
- [top](#api-endpoints-provided)
256
+ [top](#test-connection)
181
257
 
182
258
  ### ```get system```
183
259
 
@@ -210,16 +286,16 @@ Retrieves the system content for provided identification (ID) number. To invoke
210
286
 
211
287
  |parameter | type or values |
212
288
  |-------------|:----------------------------------|
213
- |--systemId |Integer - Unique system identifier |
289
+ |-s, --systemId |Integer - Unique system identifier |
214
290
 
215
291
  - Optional parameters are:
216
292
 
217
293
  |parameter | type or values |
218
294
  |------------------------|:----------------------------------------|
219
- |--includePackage |BOOLEAN - true or false |
220
- |--policy |Possible values: diacap, rmf, reporting |
295
+ |-I, --includePackage |BOOLEAN - true or false |
296
+ |-p, --policy |Possible values: diacap, rmf, reporting |
221
297
 
222
- [top](#api-endpoints-provided)
298
+ [top](#system-endpoints)
223
299
 
224
300
  ### ```get systems```
225
301
 
@@ -234,17 +310,17 @@ To retrieve controls use the following command:
234
310
 
235
311
  |parameter | type or values |
236
312
  |------------------------|:----------------------------------------------------------------------------|
237
- |--coamsId |Cyber Operational Attributes Management System (COAMS) string Id |
238
- |--ditprId |DoD Information Technology (IT) Portfolio Repository (DITPR) string id |
239
- |--includeDecommissioned |BOOLEAN - true or false |
240
- |--includeDitprMetrics |BOOLEAN - true or false |
241
- |--includePackage |BOOLEAN - true or false |
242
- |--policy |Possible values: diacap, rmf, reporting |
243
- |--registrationType |Possible values: assessAndAuthorize, assessOnly, guest, regular, functional, |
244
- | | cloudServiceProvider, commonControlProvider |
245
- |--reportsForScorecard |BOOLEAN - true or false |
313
+ |-c, --coamsId |Cyber Operational Attributes Management System (COAMS) string Id |
314
+ |-t, --ditprId |DoD Information Technology (IT) Portfolio Repository (DITPR) string id |
315
+ |-r, --registrationType |Possible values: assessAndAuthorize, assessOnly, guest, regular, functional, |
316
+ | | cloudServiceProvider, commonControlProvider |
317
+ |-I, --includeDecommissioned |BOOLEAN - true or false |
318
+ |-M, --includeDitprMetrics |BOOLEAN - true or false |
319
+ |-P, --includePackage |BOOLEAN - true or false |
320
+ |-p, --policy |Possible values: diacap, rmf, reporting |
321
+ |_S, --reportsForScorecard |BOOLEAN - true or false |
246
322
 
247
- [top](#api-endpoints-provided)
323
+ [top](#system-endpoints)
248
324
  ### ```get roles```
249
325
 
250
326
  ----
@@ -255,138 +331,140 @@ There are two get endpoints for system roles:
255
331
  ```
256
332
  - byCategory - Retrieves roles based on the following required parameter:
257
333
  ````
258
- $ bundle exec exe/emasser get roles byCategory --roleCategory=ROLECATEGORY --role=ROLE
334
+ $ bundle exec exe/emasser get roles byCategory -c, --roleCategory=ROLECATEGORY -r, --role=ROLE
259
335
  ````
260
336
  - required parameters are:
261
337
 
262
338
  |parameter | type or values |
263
339
  |:---------------|:------------------------------------------|
264
- |--roleCategory |Possible values: PAC, CAC, Other |
265
- |--role |Possible values: AO, Auditor, Artifact Manager, C&A Team, IAO, ISSO, PM/IAM, SCA, User Rep (View Only), Validator (IV&V)|
340
+ |-c, --roleCategory |Possible values: PAC, CAC, Other |
341
+ |-r, --role |Possible values: AO, Auditor, Artifact Manager, C&A Team, IAO, ISSO, PM/IAM, SCA, User Rep (View Only), Validator (IV&V)|
266
342
 
267
343
  - optional parameter are:
268
344
 
269
345
  |parameter | type or values |
270
346
  |------------------------|:----------------------------------------|
271
- |--policy |Possible values: diacap, rmf, reporting |
272
- |--includeDecommissioned |BOOLEAN - true or false |
347
+ |-p, --policy |Possible values: diacap, rmf, reporting |
348
+
273
349
 
274
- [top](#api-endpoints-provided)
350
+ [top](#system-roles-endpoints)
275
351
  ### ```get controls```
276
352
 
277
353
  ----
278
354
  To retrieve controls use the following command:
279
355
 
280
- $ bundle exec exe/emasser get controls forSystem --systemId=SYSTEMID
356
+ $ bundle exec exe/emasser get controls forSystem -s, --systemId=SYSTEMID
281
357
 
282
358
  - required parameter is:
283
359
 
284
360
  |parameter | type or values |
285
361
  |-------------|:----------------------------------|
286
- |--systemId |Integer - Unique system identifier |
362
+ |-s, --systemId |Integer - Unique system identifier |
287
363
 
288
364
  - optional parameter is:
289
365
 
290
- |parameter | type or values |
291
- |-------------|:------------------------------------------|
292
- |--acronyms |The system acronym(s) e.g "AC-1, AC-2" - if not provided all controls for systemId are returned |
366
+ |parameter | type or values |
367
+ |---------------|:------------------------------------------|
368
+ |-a, --acronyms |The system acronym(s) e.g "AC-1, AC-2" - if not provided all controls for systemId are returned |
293
369
 
294
- [top](#api-endpoints-provided)
370
+ [top](#controls-endpoint)
295
371
  ### ```get test_results```
296
372
 
297
373
  ----
298
374
  To retrieve test results use the following command:
299
375
 
300
- $ bundle exec exe/emasser get test_results forSystem --systemId=SYSTEMID
376
+ $ bundle exec exe/emasser get test_results forSystem -s, --systemId=SYSTEMID
301
377
 
302
378
  - required parameter is:
303
379
 
304
380
  |parameter | type or values |
305
381
  |-------------|:----------------------------------|
306
- |--systemId |Integer - Unique system identifier |
382
+ |-s, --systemId |Integer - Unique system identifier |
307
383
 
308
384
  - optional parameters are:
309
385
 
310
386
  |parameter | type or values |
311
387
  |-------------------|:------------------------------------------|
312
- |--controlAcronyms |String - The system acronym(s) e.g "AC-1, AC-2" |
313
- |--ccis |String - The system CCIS string numerical value |
314
- |--latestOnly |BOOLEAN - true or false|
388
+ |-a, --controlAcronyms |String - The system acronym(s) e.g "AC-1, AC-2" |
389
+ |-p, --assessmentProcedures|String - The system Security Control Assessment Procedure e.g "AC-1.1,AC-1.2"|
390
+ |-c, --ccis |String - The system CCIS string numerical value |
391
+ |-L, --latestOnly |BOOLEAN - true or false|
315
392
 
316
- [top](#api-endpoints-provided)
393
+ [top](#test-results-endpoint)
317
394
  ### ```get poams```
318
395
 
319
396
  ----
320
397
  There are two get endpoints for system poams:
321
398
  - forSystem - Retrieves all poams for specified system ID
322
399
  ````
323
- $ bundle exec exe/emasser get poams forSystem --systemId=SYSTEMID
400
+ $ bundle exec exe/emasser get poams forSystem -s, --systemId=SYSTEMID
324
401
  ````
325
402
  - required parameter is:
326
403
 
327
404
  |parameter | type or values |
328
405
  |-------------|:----------------------------------|
329
- |--systemId |Integer - Unique system identifier |
406
+ |-s, --systemId |Integer - Unique system identifier |
330
407
 
331
408
  - optional parameters are:
332
409
 
333
410
  |parameter | type or values |
334
411
  |-------------------------------|:----------------------------------------------|
335
- |--scheduledCompletionDateStart |Date - Unix time format (e.g. 1499644800) |
336
- |--scheduledCompletionDateEnd |Date - Unix time format (e.g. 1499990400) |
337
- |--controlAcronyms |String - The system acronym(s) e.g "AC-1, AC-2"|
338
- |--ccis |String - The system CCIS string numerical value|
339
- |--systemOnly |BOOLEAN - true or false|
412
+ |-d, --scheduledCompletionDateStart |Date - Unix time format (e.g. 1499644800) |
413
+ |-e, --scheduledCompletionDateEnd |Date - Unix time format (e.g. 1499990400) |
414
+ |-a, --controlAcronyms |String - The system acronym(s) e.g "AC-1, AC-2"|
415
+ |-p, --assessmentProcedures |String - The system Security Control Assessment Procedure e.g "AC-1.1,AC-1.2"|
416
+ |-c, --ccis |String - The system CCIS string numerical value|
417
+ |-Y, --systemOnly |BOOLEAN - true or false|
340
418
 
341
419
 
342
420
  - byPoamId - Retrieves all poams for specified system and poam ID
343
421
  ````
344
- $ bundle exec exe/emasser get poams byPoamId --systemId=SYSTEMID --poamId=POAMID
422
+ $ bundle exec exe/emasser get poams byPoamId -s, --systemId=SYSTEMID -p, --poamId=POAMID
345
423
  ````
346
424
  - required parameters are:
347
425
 
348
426
  |parameter | type or values |
349
427
  |-------------|:----------------------------------|
350
- |--systemId |Integer - Unique system identifier |
351
- |--poamId |Integer - Unique poam identifier |
428
+ |-s, --systemId |Integer - Unique system identifier |
429
+ |-p, --poamId |Integer - Unique poam identifier |
352
430
 
353
- [top](#api-endpoints-provided)
431
+ [top](#poams-endpoints)
354
432
  ### ```get milestones```
355
433
 
356
434
  ----
357
435
  There are two get endpoints for system milestones:
358
436
  - byPoamId - Retrieves milestone(s) for specified system and poam ID
359
437
  ````
360
- $ bundle exec exe/emasser get milestones byPoamId --systemId=SYSTEMID --poamId=POAMID
438
+ $ bundle exec exe/emasser get milestones byPoamId -s, --systemId=SYSTEMID -p, --poamId=POAMID
361
439
  ````
362
440
  - required parameters are:
363
441
 
364
442
  |parameter | type or values |
365
443
  |-------------|:----------------------------------|
366
- |--systemId |Integer - Unique system identifier |
367
- |--poamId |Integer - Unique poam identifier |
444
+ |-s, --systemId |Integer - Unique system identifier |
445
+ |-p, --poamId |Integer - Unique poam identifier |
368
446
 
369
447
  - optional parameters are:
370
448
 
371
449
  |parameter | type or values |
372
450
  |-------------------------------|:----------------------------------------------|
373
- |--scheduledCompletionDateStart |Date - Unix time format (e.g. 1499644800) |
374
- |--scheduledCompletionDateEnd |Date - Unix time format (e.g. 1499990400) |
451
+ |-d, --scheduledCompletionDateStart |Date - Unix time format (e.g. 1499644800) |
452
+ |-e, --scheduledCompletionDateEnd |Date - Unix time format (e.g. 1499990400) |
375
453
 
376
454
 
377
455
  - byMilestoneId, Retrieve milestone(s) for specified system, poam, and milestone ID"
378
456
  ````
379
- $ bundle exec exe/emasser get poams byMilestoneId --systemId=SYSTEMID --poamId=POAMID --milestoneId=MILESTONEID
457
+ $ bundle exec exe/emasser get poams byMilestoneId -s, --systemId=SYSTEMID -p, --poamId=POAMID -m, --milestoneId=MILESTONEID
380
458
  ````
381
459
  - required parameters are:
382
460
 
383
461
  |parameter | type or values |
384
462
  |--------------|:-------------------------------------|
385
- |--systemId |Integer - Unique system identifier |
386
- |--poamId |Integer - Unique poam identifier |
387
- |--milestoneId |Integer - Unique milestone identifier |
463
+ |-s, --systemId |Integer - Unique system identifier |
464
+ |-p, --poamId |Integer - Unique poam identifier |
465
+ |-m, --milestoneId |Integer - Unique milestone identifier |
388
466
 
389
- [top](#api-endpoints-provided)
467
+ [top](#milestones-endpoints)
390
468
  ### ```get artifacts```
391
469
 
392
470
  ----
@@ -394,91 +472,93 @@ There are two get endpoints that provides the ability to view existing `Artifact
394
472
 
395
473
  - forSystem - Retrieves one or many artifacts in a system specified system ID
396
474
  ````
397
- $ bundle exec exe/emasser get artifacts forSystem --systemId=SYSTEMID
475
+ $ bundle exec exe/emasser get artifacts forSystem -s, --systemId=SYSTEMID
398
476
  ````
399
477
  - required parameter is:
400
478
 
401
479
  |parameter | type or values |
402
480
  |-------------|:----------------------------------|
403
- |--systemId |Integer - Unique system identifier |
481
+ |-s, --systemId |Integer - Unique system identifier |
404
482
 
405
483
  - optional parameters are:
406
484
 
407
- |parameter | type or values |
408
- |-------------------------------|:----------------------------------------------|
409
- |--filename |The artifact file name |
410
- |--controlAcronyms |String - The system acronym(s) e.g "AC-1, AC-2"|
411
- |--ccis |String - The system CCIS string numerical value|
412
- |--systemOnly |BOOLEAN - true or false|
485
+ |parameter | type or values |
486
+ |---------------------------|:----------------------------------------------|
487
+ |-f, --filename |The artifact file name |
488
+ |-a, --controlAcronyms |String - The system acronym(s) e.g "AC-1, AC-2"|
489
+ |-p, --assessmentProcedures |String - The system Security Control Assessment Procedure e.g "AC-1.1,AC-1.2"|
490
+ |-c, --ccis |String - The system CCIS string numerical value|
491
+ |-Y, --systemOnly |BOOLEAN - true or false|
413
492
 
414
493
 
415
494
  - export - Retrieves the file artifacts (if compress is true the file binary contents are returned, otherwise the file textual contents are returned.)
416
495
  ````
417
- $ bundle exec exe/emasser get artifacts export --systemId=SYSTEMID
496
+ $ bundle exec exe/emasser get artifacts export -s, --systemId=SYSTEMID
418
497
  ````
419
498
  - required parameters are:
420
499
 
421
500
  |parameter | type or values |
422
501
  |-------------|:----------------------------------|
423
- |--systemId |Integer - Unique system identifier |
424
- |--filename |The artifact file name |
502
+ |-s, --systemId |Integer - Unique system identifier |
503
+ |-f, --filename |The artifact file name |
425
504
 
426
505
  - optional parameter is:
427
506
 
428
507
  |parameter | type or values |
429
508
  |-------------|:----------------------------------|
430
- |--compress |BOOLEAN - true or false. |
509
+ |-C, --compress |BOOLEAN - true or false. |
510
+ |-o, --printToStdout |BOOLEAN - true or false - Output file content to terminal - not valid for zip files|
431
511
 
432
- [top](#api-endpoints-provided)
512
+ [top](#artifacts-endpoints)
433
513
  ### ```get cac```
434
514
 
435
515
  ----
436
516
  To view one or many Control Approval Chain (CAC) in a system specified system ID use the following command:
437
517
  ```
438
- $ bundle exec exe/emasser get cac controls --systemId=SYSTEMID
518
+ $ bundle exec exe/emasser get cac controls -s, --systemId=SYSTEMID
439
519
  ```
440
520
  - required parameter is:
441
521
 
442
522
  |parameter | type or values |
443
523
  |-------------|:----------------------------------|
444
- |--systemId |Integer - Unique system identifier |
524
+ |-s, --systemId |Integer - Unique system identifier |
445
525
 
446
526
  - optional parameter is:
447
527
 
448
- |parameter | type or values |
449
- |-------------------------------|:----------------------------------------------|
450
- |--controlAcronyms |String - The system acronym(s) e.g "AC-1, AC-2"|
528
+ |parameter | type or values |
529
+ |----------------------|:----------------------------------------------|
530
+ |-a, --controlAcronyms |String - The system acronym(s) e.g "AC-1, AC-2"|
451
531
 
452
- [top](#api-endpoints-provided)
532
+ [top](#cac-endpoint)
453
533
  ### ```get pac```
454
534
 
455
535
  ----
456
536
  To view one or many Package Approval Chain (PAC) in a system specified system ID use the following command:
457
537
 
458
538
  ````
459
- $ bundle exec exe/emasser get pac package --systemId=SYSTEMID
539
+ $ bundle exec exe/emasser get pac package -s, --systemId=SYSTEMID
460
540
  ````
461
541
  - required parameter is:
462
542
 
463
543
  |parameter | type or values |
464
544
  |-------------|:----------------------------------|
465
- |--systemId |Integer - Unique system identifier |
545
+ |-s, --systemId |Integer - Unique system identifier |
466
546
 
467
- [top](#api-endpoints-provided)
547
+ [top](#pac-endpoint)
468
548
  ### ```get cmmc```
469
549
 
470
550
  ----
471
551
  To view Cybersecurity Maturity Model Certification (CMMC) Assessments use the following command:
472
552
 
473
- $ bundle exec exe/emasser get workflow_definitions forSite --sinceDate=SINCEDATE
553
+ $ bundle exec exe/emasser get cmmc assessments -d, --sinceDate=SINCEDATE
474
554
 
475
555
  - Required parameter is:
476
556
 
477
557
  |parameter | type or values |
478
558
  |----------------|:--------------------------------------|
479
- |--sinceDate |Date - The CMMC date. Unix date format |
559
+ |-d, --sinceDate |Date - The CMMC date. Unix date format |
480
560
 
481
- [top](#api-endpoints-provided)
561
+ [top](#cmmc-assessment-endpoint)
482
562
  ### ```get workflow_definitions```
483
563
 
484
564
  ----
@@ -490,11 +570,11 @@ To view Workflow Definitions use the following command:
490
570
 
491
571
  |parameter | type or values |
492
572
  |---------------------|:----------------------------------------------------------------------------|
493
- |--includeInactive |BOOLEAN - true or false |
494
- |--registrationType |Possible values: assessAndAuthorize, assessOnly, guest, regular, functional, |
495
- | | cloudServiceProvider, commonControlProvider |
573
+ |-I, --includeInactive |BOOLEAN - true or false |
574
+ |-r, --registrationType |Possible values: assessAndAuthorize, assessOnly, guest, regular, functional, |
575
+ | | cloudServiceProvider, commonControlProvider |
496
576
 
497
- [top](#api-endpoints-provided)
577
+ [top](#workflow-definition-endpoint)
498
578
  ### ```get workflow_instances```
499
579
 
500
580
  ----
@@ -507,22 +587,23 @@ There are two get endpoints to view workflow instances:
507
587
 
508
588
  |parameter | type or values |
509
589
  |-------------------|:---------------------------------------------------|
510
- |--includeComments |BOOLEAN - true or false |
511
- |--pageIndex |Integer - The page number to query |
512
- |--sinceDate |Date - The Workflow Instance date. Unix date format |
513
- |--status |Possible values: active, inactive, all |
590
+ |-C, --includeComments |BOOLEAN - true or false |
591
+ |-D, --includeDecommissionSystems |BOOLEAN - true or false. |
592
+ |-p, --pageIndex |Integer - The page number to query |
593
+ |-d, --sinceDate |Date - The Workflow Instance date. Unix date format |
594
+ |-s, --status |Possible values: active, inactive, all |
514
595
 
515
- - byWorkflowInstanceId
596
+ - byInstanceId
516
597
  ```
517
- $ bundle exec exe/emasser get workflow_instances byWorkflowInstanceId --workflowInstanceId=WORKFLOWID
598
+ $ bundle exec exe/emasser get workflow_instances byInstanceId --workflowInstanceId=WORKFLOWID
518
599
  ```
519
600
  - required parameter is:
520
601
 
521
602
  |parameter | type or values |
522
603
  |---------------------|:---------------------------------------------|
523
- |--workflowInstanceId |Integer - Unique workflow instance identifier |
604
+ |-w, --workflowInstanceId |Integer - Unique workflow instance identifier |
524
605
 
525
- [top](#api-endpoints-provided)
606
+ [top](#workflow-instances-endpoint)
526
607
  ### ```get dashboards```
527
608
 
528
609
  ----
@@ -533,21 +614,34 @@ All endpoint calls utilize the same parameter values, they are:
533
614
 
534
615
  |parameter | type or values |
535
616
  |--------------|:------------------------------------------------|
536
- |--orgId |Integer - The organization identification number |
617
+ |-o, --orgId |Integer - The organization identification number |
537
618
 
538
619
  - Optional flags (parameters) are:
539
620
 
540
621
  |parameter | type or values |
541
622
  |-------------------|:--------------------------------------------------------------|
542
- |--excludeInherited |BOOLEAN - If no value is specified, includes inherited data |
543
- |--pageIndex |Integer - The index of the starting page (default first page 0)|
544
- |--pageSize |Integer - The number of entries per page (default 20000) |
623
+ |-I, --excludeInherited |BOOLEAN - If no value is specified, includes inherited data |
624
+ |-i, --pageIndex |Integer - The index of the starting page (default first page 0)|
625
+ |-s, --pageSize |Integer - The number of entries per page (default 20000) |
626
+ [top](#dashboards)
545
627
 
546
- Available commands are:
628
+ #### System Status Endpoint
547
629
  - Get systems status detail dashboard information
548
630
  ```
549
631
  $ bundle exec exe/emasser get dashboards status_details [-o, --orgId] <value> [options]
550
632
  ```
633
+ [top](#system-status-dashboard)
634
+ #### System Terms Conditions Endpoints
635
+ - Get system terms/conditions summary dashboard information
636
+ ```
637
+ $ bundle exec exe/emasser get dashboards terms_conditions_summary [-o, --orgId] <value> [options]
638
+ ```
639
+ - Get system terms/conditions details dashboard information
640
+ ```
641
+ $ bundle exec exe/emasser get dashboards terms_conditions_detail [-o, --orgId] <value> [options]
642
+ ```
643
+ [top](#enterprise-terms-conditions-dashboard)
644
+ ### Enterprise Security Controls Endpoints
551
645
  - Get systems control compliance summary dashboard information
552
646
  ```
553
647
  $ bundle exec exe/emasser get dashboards control_compliance_summary [-o, --orgId] <value> [options]
@@ -560,6 +654,9 @@ Available commands are:
560
654
  ```
561
655
  $ bundle exec exe/emasser get dashboards assessment_procedures_details [-o, --orgId] <value> [options]
562
656
  ```
657
+ [top](#enterprise-security-controls-dashboard)
658
+ ### Enterprise POA&M Endpoints
659
+
563
660
  - Get systems POA&Ms summary dashboard information
564
661
  ```
565
662
  $ bundle exec exe/emasser get dashboards poam_summary [-o, --orgId] <value> [options]
@@ -568,6 +665,8 @@ Available commands are:
568
665
  ```
569
666
  $ bundle exec exe/emasser get dashboards poam_details [-o, --orgId] <value> [options]
570
667
  ```
668
+ [top](#enterprise-poam-dashboard)
669
+ ### Enterprise Artifacts Endpoints
571
670
  - Get artifacts summary dashboard information
572
671
  ```
573
672
  $ bundle exec exe/emasser get dashboards artifacts_summary [-o, --orgId] <value> [options]
@@ -576,6 +675,8 @@ Available commands are:
576
675
  ```
577
676
  $ bundle exec exe/emasser get dashboards artifacts_details [-o, --orgId] <value> [options]
578
677
  ```
678
+ [top](#enterprise-artifacts-dashboard)
679
+ ### Hardware Baseline Endpoints
579
680
  - Get system hardware summary dashboard information
580
681
  ```
581
682
  $ bundle exec exe/emasser get dashboards hardware_summary [-o, --orgId] <value> [options]
@@ -584,6 +685,8 @@ Available commands are:
584
685
  ```
585
686
  $ bundle exec exe/emasser get dashboards hardware_details [-o, --orgId] <value> [options]
586
687
  ```
688
+ [top](#hardware-baseline-dashboard)
689
+ ### Enterprise Sensor-based Hardware Resources Endpoints
587
690
  - Get sensor hardware summary dashboard information
588
691
  ```
589
692
  $ bundle exec exe/emasser get dashboards sensor_hardware_summary [-o, --orgId] <value> [options]
@@ -592,6 +695,8 @@ Available commands are:
592
695
  ```
593
696
  $ bundle exec exe/emasser get dashboards sensor_hardware_details [-o, --orgId] <value> [options]
594
697
  ```
698
+ [top](#enterprise-sensor-based-hardware-resources-dashboard)
699
+ ### Software Baseline Endpoints
595
700
  - Get software baseline summary dashboard information
596
701
  ```
597
702
  $ bundle exec exe/emasser get dashboards software_summary [-o, --orgId] <value> [options]
@@ -600,6 +705,37 @@ Available commands are:
600
705
  ```
601
706
  $ bundle exec exe/emasser get dashboards software_details [-o, --orgId] <value> [options]
602
707
  ```
708
+ [top](#software-baseline-dashboard)
709
+
710
+ ### Enterprise Sensor-based Software Resources Endpoints
711
+ - Get sensor based software resources summary dashboard information
712
+ ```
713
+ $ bundle exec exe/emasser get dashboards sensor_software_summary [-o, --orgId] <value> [options]
714
+ ```
715
+ - Get sensor based software resources details dashboard information
716
+ ```
717
+ $ bundle exec exe/emasser get dashboards sensor_software_details [-o, --orgId] <value> [options]
718
+ ```
719
+ - Get sensor based software resources counts dashboard information
720
+ ```
721
+ $ bundle exec exe/emasser get dashboards sensor_software_counts [-o, --orgId] <value> [options]
722
+ ```
723
+ [top](#enterprise-sensor-based-software-resources-dashboard)
724
+ ### Enterprise Vulnerability Endpoints
725
+ - Get vulnerability summary dashboard information
726
+ ```
727
+ $ bundle exec exe/emasser get dashboards vulnerability_summary [-o, --orgId] <value> [options]
728
+ ```
729
+ - Get device findings summary dashboard information
730
+ ```
731
+ $ bundle exec exe/emasser get dashboards device_findings_summary [-o, --orgId] <value> [options]
732
+ ```
733
+ - Get device findings details dashboard information
734
+ ```
735
+ $ bundle exec exe/emasser get dashboards device_findings_details [-o, --orgId] <value> [options]
736
+ ```
737
+ [top](#enterprise-vulnerability-dashboard)
738
+ ### Ports and Protocols Endpoints
603
739
  - Get ports and protocols summary dashboard information
604
740
  ```
605
741
  $ bundle exec exe/emasser get dashboards ports_protocols_summary [-o, --orgId] <value> [options]
@@ -608,18 +744,27 @@ Available commands are:
608
744
  ```
609
745
  $ bundle exec exe/emasser get dashboards ports_protocols_details [-o, --orgId] <value> [options]
610
746
  ```
747
+ [top](#ports-and-protocols-dashboard)
748
+
749
+ ### System CONMON Integration Status Endpoint
611
750
  - Get CONMON integration status summary dashboard information
612
751
  ```
613
752
  $ bundle exec exe/emasser get dashboards integration_status_summary [-o, --orgId] <value> [options]
614
753
  ```
754
+ [top](#system-conmon-integration-status-dashboard)
755
+ ### System Associations Endpoint
615
756
  - Get system associations details dashboard information
616
757
  ```
617
758
  $ bundle exec exe/emasser get dashboards associations_details [-o, --orgId] <value> [options]
618
759
  ```
760
+ [top](#system-associations-dashboard)
761
+ ### Users Endpoint
619
762
  - Get user system assignments details dashboard information
620
763
  ```
621
764
  $ bundle exec exe/emasser get dashboards assignments_details [-o, --orgId] <value> [options]
622
765
  ```
766
+ [top](#users-dashboard)
767
+ ### Privacy Compliance Endpoints
623
768
  - Get user system privacy summary dashboard information
624
769
  ```
625
770
  $ bundle exec exe/emasser get dashboards privacy_summary [-o, --orgId] <value> [options]
@@ -628,18 +773,26 @@ Available commands are:
628
773
  ```
629
774
  $ bundle exec exe/emasser get dashboards fisma_saop_summary [-o, --orgId] <value> [options]
630
775
  ```
776
+ [top](#privacy-compliance-dashboard)
777
+ ### System A&A Summary Endpoint
631
778
  - Get VA system A&A summary dashboard information
632
779
  ```
633
780
  $ bundle exec exe/emasser get dashboards va_aa_summary [-o, --orgId] <value> [options]
634
781
  ```
782
+ [top](#system-aa-summary-dashboard)
783
+ ### System A2.0 Summary Endpoint
635
784
  - Get VA system A2.0 summary dashboard information
636
785
  ```
637
786
  $ bundle exec exe/emasser get dashboards va_a2_summary [-o, --orgId] <value> [options]
638
787
  ```
788
+ [top](#system-a20-summary-dashboard)
789
+ ### System P.L. 109 Reporting Summary Endpoint
639
790
  - Get VA System P.L. 109 reporting summary dashboard information
640
791
  ```
641
792
  $ bundle exec exe/emasser get dashboards va_pl_109_summary [-o, --orgId] <value> [options]
642
793
  ```
794
+ [top](#system-pl-109-reporting-summary-dashboard)
795
+ ### FISMA Inventory Summary Endpoints
643
796
  - Get VA system FISMA inventory summary dashboard information
644
797
  ```
645
798
  $ bundle exec exe/emasser get dashboards fisma_inventory_summary [-o, --orgId] <value> [options]
@@ -648,6 +801,8 @@ Available commands are:
648
801
  ```
649
802
  $ bundle exec exe/emasser get dashboards fisma_inventory_crypto_summary [-o, --orgId] <value> [options]
650
803
  ```
804
+ [top](#fisma-inventory-summary-dashboard)
805
+ ### Threat Risks Endpoints
651
806
  - Get VA threat risk summary dashboard information
652
807
  ```
653
808
  $ bundle exec exe/emasser get dashboards va_threat_risk_summary [-o, --orgId] <value> [options]
@@ -660,7 +815,7 @@ Available commands are:
660
815
  ```
661
816
  $ bundle exec exe/emasser get dashboards va_threat_architecture_details [-o, --orgId] <value> [options]
662
817
  ```
663
- [top](#api-endpoints-provided)
818
+ [top](#threat-risks-dashboard)
664
819
 
665
820
  ## Usage - POST
666
821
 
@@ -684,7 +839,7 @@ Test Result add (POST) endpoint API business rules.
684
839
  To add (POST) test results use the following command:
685
840
 
686
841
  ````
687
- $ bundle exec exe/emasser post test_results add --systemId [value] --cci [value] --testedBy [value] --testDate [value] --description [value] --complianceStatus [value]
842
+ $ bundle exec exe/emasser post test_results add -s, --systemId [value] --cci [value] --testedBy [value] --testDate [value] --description [value] --complianceStatus [value]
688
843
  ````
689
844
  Note: If no POA&Ms or AP exist for the control (system), you will get this response:
690
845
  "You have entered a Non-Compliant Test Result. You must create a POA&M Item for this Control and/or AP if one does not already exist."
@@ -693,7 +848,7 @@ Note: If no POA&Ms or AP exist for the control (system), you will get this respo
693
848
 
694
849
  |parameter | type or values |
695
850
  |-------------------|:------------------------------------------------------------|
696
- |--systemId |Integer - Unique system identifier |
851
+ |-s, --systemId |Integer - Unique system identifier |
697
852
  |--cci |String - CCI associated with the test result. e.g "00221" |
698
853
  |--testedBy |String - Last Name, First Name. 100 Characters. |
699
854
  |--testDate |Date - Unix time format (e.g. 1499990400) |
@@ -705,7 +860,7 @@ For information at the command line use:
705
860
  ```
706
861
  $ bundle exec exe/emasser post test_results help add
707
862
  ```
708
- [top](#post)
863
+ [top](#post-endpoints)
709
864
 
710
865
  ### ``post poams``
711
866
  ---
@@ -765,7 +920,7 @@ The following POA&M parameters/fields have the following character limitations:
765
920
 
766
921
  To add (POST) POA&Ms use the following command:
767
922
  ```
768
- $ bundle exec exe/emasser post poams add --systemId [value] --status [value] --vulnerabilityDescription [value] --sourceIdentVuln [value] --pocOrganization [value] --resources [value]
923
+ $ bundle exec exe/emasser post poams add -s, --systemId [value] --status [value] --vulnerabilityDescription [value] --sourceIdentVuln [value] --pocOrganization [value] --resources [value]
769
924
  ```
770
925
  **Notes:**
771
926
  - The above listed parameters/fields are the minimal required.
@@ -782,7 +937,7 @@ Client API parameters/fields (required, conditional, and optional).
782
937
 
783
938
  |parameter | type or values |
784
939
  |---------------------------|:---------------------------------------------------------------|
785
- |--systemId |Integer - Unique system identifier |
940
+ |-s, --systemId |Integer - Unique system identifier |
786
941
  |--status |Possible Values: Ongoing,Risk Accepted,Completed,Not Applicable |
787
942
  |--vulnerabilityDescription |String - Vulnerability description for the POA&M Item |
788
943
  |--sourceIdentVuln |String - Include Source Identifying Vulnerability text |
@@ -834,21 +989,21 @@ For information at the command line use:
834
989
  ```
835
990
  $ bundle exec exe/emasser post poams help add
836
991
  ```
837
- [top](#post)
992
+ [top](#post-endpoints)
838
993
 
839
994
  ### ``post milestones``
840
995
  ---
841
996
  To add (POST) milestones in a system for one or more POA&M items use the following command:
842
997
 
843
998
  ````
844
- $ bundle exec exe/emasser post milestones add --systemId [value] --poamId [value] --description [value] --scheduledCompletionDate [value]
999
+ $ bundle exec exe/emasser post milestones add -s, --systemId [value] -p, --poamId [value] --description [value] --scheduledCompletionDate [value]
845
1000
  ````
846
1001
  - required parameter are:
847
1002
 
848
1003
  |parameter | type or values |
849
1004
  |---------------------------|:----------------------------------------------------|
850
- |--systemId |Integer - Unique system identifier |
851
- |--poamId |Integer - Unique item identifier |
1005
+ |-s, --systemId |Integer - Unique system identifier |
1006
+ |-p, --poamId |Integer - Unique item identifier |
852
1007
  |--description |String - Milestone item description. 2000 Characters |
853
1008
  |--scheduledCompletionDate |Date - Schedule completion date. Unix date format |
854
1009
 
@@ -858,7 +1013,7 @@ For information at the command line use:
858
1013
  ```
859
1014
  $ bundle exec exe/emasser post milestones help add
860
1015
  ```
861
- [top](#post)
1016
+ [top](#post-endpoints)
862
1017
 
863
1018
  ### ``post artifacts``
864
1019
  ---
@@ -887,14 +1042,14 @@ Business Rules:
887
1042
  To add (POST) artifacts use the following command:
888
1043
 
889
1044
  ```
890
- $ bundle exec exe/emasser post artifacts upload --systemId [value] [--isTemplate or --no-isTemplate] --type [value] --category [value] --files [value...value]
1045
+ $ bundle exec exe/emasser post artifacts upload -s, --systemId [value] [--isTemplate or --no-isTemplate] --type [value] --category [value] --files [value...value]
891
1046
  ```
892
1047
 
893
1048
  - required parameter are:
894
1049
 
895
1050
  |parameter | type or values |
896
1051
  |----------------|:----------------------------------------------------|
897
- |--systemId |Integer - Unique system identifier |
1052
+ |-s, --systemId |Integer - Unique system identifier |
898
1053
  |--isTemplate |Boolean - Indicates whether an artifact is a template|
899
1054
  |--type |Possible Values: Procedure, Diagram, Policy, Labor, Document, Image, Other, Scan Result, Auditor Report|
900
1055
  |--category |Possible Values: Implementation Guidance, Evidence |
@@ -906,7 +1061,7 @@ $ bundle exec exe/emasser post artifacts upload --systemId [value] [--isTemplate
906
1061
  |-------------------------|:------------------------------------------------------|
907
1062
  |--description |String - Artifact description. 2000 Characters |
908
1063
  |--refPageNumber |String - Artifact reference page number. 50 Characters |
909
- |--ccis |String - CCIs associated with artifact |
1064
+ |-c, --ccis |String - CCIs associated with artifact |
910
1065
  |--controls |String - Control acronym associated with the artifact. NIST SP 800-53 Revision 4 defined|
911
1066
  |--artifactExpirationDate |Date - Date Artifact expires and requires review. In Unix Date Format|
912
1067
  |--lastReviewedDate |Date - Date Artifact was last reviewed. In Unix Date Format |
@@ -917,7 +1072,7 @@ For information at the command line use:
917
1072
  ```
918
1073
  $ bundle exec exe/emasser post artifacts help upload
919
1074
  ```
920
- [top](#post)
1075
+ [top](#post-endpoints)
921
1076
 
922
1077
  ### ``post cac``
923
1078
  ----
@@ -929,13 +1084,13 @@ Business Rule
929
1084
  To add (POST) test CAC use the following command:
930
1085
 
931
1086
  ````
932
- $ bundle exec exe/emasser post pac add --systemId [value] --controlAcronym [value] --comments [value]
1087
+ $ bundle exec exe/emasser post pac add -s, --systemId [value] --controlAcronym [value] --comments [value]
933
1088
  ````
934
1089
  - required parameter are:
935
1090
 
936
1091
  |parameter | type or values |
937
1092
  |-------------------|:------------------------------------------------------------|
938
- |--systemId |Integer - Unique system identifier |
1093
+ |-s, --systemId |Integer - Unique system identifier |
939
1094
  |--controlAcronym |String - Control acronym associated with the POA&M Item. NIST SP 800-53 Revision 4 defined |
940
1095
 
941
1096
  - conditional parameter is:
@@ -949,7 +1104,7 @@ For information at the command line use:
949
1104
  ```
950
1105
  $ bundle exec exe/emasser post cac help add
951
1106
  ```
952
- [top](#post)
1107
+ [top](#post-endpoints)
953
1108
 
954
1109
  ### ``post pac``
955
1110
  ----
@@ -958,13 +1113,13 @@ Submit control to second role of CAC
958
1113
  To add (POST) test PAC use the following command:
959
1114
 
960
1115
  ````
961
- $ bundle exec exe/emasser post pac add --systemId [value] --workflow [value] --name [value] --comments [value]
1116
+ $ bundle exec exe/emasser post pac add -s, --systemId [value] --workflow [value] --name [value] --comments [value]
962
1117
  ````
963
1118
  - required parameter are:
964
1119
 
965
1120
  |parameter | type or values |
966
1121
  |--------------|:--------------------------------------------------------------------------|
967
- |--systemId |Integer - Unique system identifier |
1122
+ |-s, --systemId |Integer - Unique system identifier |
968
1123
  |--workflow |Possible Values: Assess and Authorize, Assess Only, Security Plan Approval |
969
1124
  |--name |String - Package name. 100 Characters |
970
1125
  |--comments |String - Comments submitted upon initiation of the indicated workflow, 4,000 character|
@@ -974,20 +1129,20 @@ For information at the command line use:
974
1129
  ```
975
1130
  $ bundle exec exe/emasser post pac help add
976
1131
  ```
977
- [top](#post)
1132
+ [top](#post-endpoints)
978
1133
 
979
1134
  ### ``post static_code_scan``
980
1135
  ----
981
1136
  To add (POST) static code scans use the following command:
982
1137
 
983
1138
  ````
984
- $ bundle exec exe/emasser post scan_findings add --systemId [value] --applicationName [value] --version [value] --codeCheckName [value] --scanDate [value] --cweId [value]
1139
+ $ bundle exec exe/emasser post scan_findings add -s, --systemId [value] --applicationName [value] --version [value] --codeCheckName [value] --scanDate [value] --cweId [value]
985
1140
  ````
986
1141
  - required parameter are:
987
1142
 
988
1143
  |parameter | type or values |
989
1144
  |-------------------|:-----------------------------------------------------------|
990
- |--systemId |Integer - Unique system identifier |
1145
+ |-s, --systemId |Integer - Unique system identifier |
991
1146
  |--applicationName |String - Name of the software application that was assessed |
992
1147
  |--version |String - The version of the application |
993
1148
  |--codeCheckName |Strings - Name of the software vulnerability or weakness |
@@ -1006,13 +1161,13 @@ To add (POST) static code scans use the following command:
1006
1161
  To clear (POST) static code scans use the following command:
1007
1162
 
1008
1163
  ````
1009
- $ bundle exec exe/emasser post scan_findings clear --systemId [value] --applicationName [value] --version [value] --clearFindings
1164
+ $ bundle exec exe/emasser post scan_findings clear -s, --systemId [value] --applicationName [value] --version [value] --clearFindings
1010
1165
  ````
1011
1166
  - required parameter are:
1012
1167
 
1013
1168
  |parameter | type or values |
1014
1169
  |-------------------|:-----------------------------------------------------------|
1015
- |--systemId |Integer - Unique system identifier |
1170
+ |-s, --systemId |Integer - Unique system identifier |
1016
1171
  |--applicationName |String - Name of the software application that was assessed |
1017
1172
  |--clearFindings* |Boolean - To clear an application's findings set it to true |
1018
1173
 
@@ -1023,7 +1178,7 @@ For information at the command line use:
1023
1178
  ```
1024
1179
  $ bundle exec exe/emasser post scan_findings help add
1025
1180
  ```
1026
- [top](#post)
1181
+ [top](#post-endpoints)
1027
1182
 
1028
1183
  ### ```post cloud_resource```
1029
1184
  ---
@@ -1051,13 +1206,13 @@ The following Cloud Resource parameters/fields have the following character limi
1051
1206
 
1052
1207
  To add a cloud resource and their scan results in the assets module for a system use the following command:
1053
1208
  ````
1054
- $ bundle exec exe/emasser post cloud_resource add --systemId [value] --provider [value] --resourceId [value] --resourceName [value] --resourceType [value] --cspPolicyDefinitionId [value] --isCompliant or --is-not-Compliant --policyDefinitionTitle [value] --test [value]
1209
+ $ bundle exec exe/emasser post cloud_resource add -s, --systemId [value] --provider [value] --resourceId [value] --resourceName [value] --resourceType [value] --cspPolicyDefinitionId [value] --isCompliant or --is-not-Compliant --policyDefinitionTitle [value] --test [value]
1055
1210
  ````
1056
1211
  - required parameter are:
1057
1212
 
1058
1213
  |parameter | type or values |
1059
1214
  |------------------------|:--------------------------------------------------------------------------|
1060
- |--systemId |Integer - Unique system identifier |
1215
+ |-s, --systemId |Integer - Unique system identifier |
1061
1216
  |--provider |string - Cloud service provider name |
1062
1217
  |--resourceId |String - Unique identifier/resource namespace for policy compliance result |
1063
1218
  |--resourceName |String - Friendly name of Cloud resource |
@@ -1092,7 +1247,7 @@ For information at the command line use:
1092
1247
  $ bundle exec exe/emasser post cloud_resource help add
1093
1248
  ```
1094
1249
 
1095
- [top](#post)
1250
+ [top](#post-endpoints)
1096
1251
 
1097
1252
 
1098
1253
  ### ```post container```
@@ -1113,7 +1268,7 @@ The following Container parameters/fields have the following character limitatio
1113
1268
 
1114
1269
  To add containers and their scan results in the assets module for a system use the following command:
1115
1270
  ````
1116
- $ bundle exec ruby exe/emasser post container add --systemId [value] --containerId [value] --containerName [value] --time [value] --benchmark [value] --lastSeen [value] --ruleId [value] --status [value]
1271
+ $ bundle exec ruby exe/emasser post container add -s, --systemId [value] --containerId [value] --containerName [value] --time [value] --benchmark [value] --lastSeen [value] --ruleId [value] --status [value]
1117
1272
 
1118
1273
  ````
1119
1274
 
@@ -1121,7 +1276,7 @@ To add containers and their scan results in the assets module for a system use t
1121
1276
 
1122
1277
  |parameter | type or values |
1123
1278
  |------------------------|:--------------------------------------------------------------------------|
1124
- |--systemId |Integer - Unique system identifier |
1279
+ |-s, --systemId |Integer - Unique system identifier |
1125
1280
  |--containerId |String - Unique identifier of the container |
1126
1281
  |--containerName |String - Friendly name of the container |
1127
1282
  |--time |Date - Datetime of scan/result. Unix date format |
@@ -1151,7 +1306,7 @@ For information at the command line use:
1151
1306
  ```
1152
1307
  $ bundle exec exe/emasser post container help add
1153
1308
  ```
1154
- [top](#post)
1309
+ [top](#post-endpoints)
1155
1310
 
1156
1311
  ## Usage - PUT
1157
1312
 
@@ -1196,7 +1351,7 @@ Updating (PUT) a Control can be accomplished by invoking the following command:
1196
1351
 
1197
1352
  |parameter | type or values |
1198
1353
  |--------------------------|:-------------------------------------------------------------------------|
1199
- |--systemId |Integer - Unique system identifier |
1354
+ |-s, --systemId |Integer - Unique system identifier |
1200
1355
  |--acronym |String - The system acronym(s) e.g "AC-1, AC-2" |
1201
1356
  |--responsibleEntities |String - Description of the responsible entities for the Security Control |
1202
1357
  |--controlDesignation |Possible values: Common, System-Specific, or Hybrid |
@@ -1235,7 +1390,7 @@ For information at the command line use:
1235
1390
  ```
1236
1391
  $ bundle exec exe/emasser put controls help update
1237
1392
  ```
1238
- [top](#put)
1393
+ [top](#put-emdpoints)
1239
1394
 
1240
1395
  ### ``put poams``
1241
1396
 
@@ -1316,7 +1471,7 @@ Updating (PUT) a POA&M can be accomplished by invoking the following command:
1316
1471
 
1317
1472
  |parameter | type or values |
1318
1473
  |---------------------------|:---------------------------------------------------------------|
1319
- |--systemId |Integer - Unique system identifier |
1474
+ |-s, --systemId |Integer - Unique system identifier |
1320
1475
  |--displayPoamId |Integer - Globally unique identifier for individual POA&M Items |
1321
1476
  |--status |Possible Values: Ongoing,Risk Accepted,Completed,Not Applicable |
1322
1477
  |--vulnerabilityDescription |String - Vulnerability description for the POA&M Item |
@@ -1370,7 +1525,7 @@ For information at the command line use:
1370
1525
  ```
1371
1526
  $ bundle exec exe/emasser put poams help update
1372
1527
  ```
1373
- [top](#put)
1528
+ [top](#put-endpoints)
1374
1529
 
1375
1530
  ### ``put milestones``
1376
1531
 
@@ -1385,9 +1540,9 @@ To add (POST) milestones in a system for one or more POA&M items use the followi
1385
1540
 
1386
1541
  |parameter | type or values |
1387
1542
  |---------------------------|:----------------------------------------------------|
1388
- |--systemId |Integer - Unique system identifier |
1389
- |--poamId |Integer - Unique poam identifier |
1390
- |--milestoneId |Integer - Unique milestone identifier |
1543
+ |-s, --systemId |Integer - Unique system identifier |
1544
+ |-p, --poamId |Integer - Unique poam identifier |
1545
+ |-m, --milestoneId |Integer - Unique milestone identifier |
1391
1546
  |--description |String - Milestone item description. 2000 Characters |
1392
1547
  |--scheduledCompletionDate |Date - Schedule completion date. Unix date format |
1393
1548
 
@@ -1397,7 +1552,7 @@ For information at the command line use:
1397
1552
  ```
1398
1553
  $ bundle exec exe/emasser put milestones help update
1399
1554
  ```
1400
- [top](#put)
1555
+ [top](#put-endpoints)
1401
1556
 
1402
1557
  ### ``put artifacts``
1403
1558
 
@@ -1426,8 +1581,8 @@ To add (POST) milestones in a system for one or more POA&M items use the followi
1426
1581
 
1427
1582
  |parameter | type or values |
1428
1583
  |----------------|:----------------------------------------------------|
1429
- |--systemId |Integer - Unique system identifier |
1430
- |--filename |String - File name should match exactly one file within the provided zip file|
1584
+ |-s, --systemId |Integer - Unique system identifier |
1585
+ |-f, --filename |String - File name should match exactly one file within the provided zip file|
1431
1586
  | |Binary - Application/zip file. Max 30MB per artifact |
1432
1587
  |--isTemplate |Boolean - Indicates whether an artifact is a template|
1433
1588
  |--type* |Possible Values: Procedure, Diagram, Policy, Labor, Document, Image, Other, Scan Result, Auditor Report|
@@ -1441,7 +1596,7 @@ To add (POST) milestones in a system for one or more POA&M items use the followi
1441
1596
  |-------------------------|:------------------------------------------------------|
1442
1597
  |--description |String - Artifact description. 2000 Characters |
1443
1598
  |--refPageNumber |String - Artifact reference page number. 50 Characters |
1444
- |--ccis |String - CCIs associated with artifact |
1599
+ |-c, --ccis |String - CCIs associated with artifact |
1445
1600
  |--controls |String - Control acronym associated with the artifact. NIST SP 800-53 Revision 4 defined|
1446
1601
  |--artifactExpirationDate |Date - Date Artifact expires and requires review. In Unix Date Format|
1447
1602
  |--lastReviewedDate |Date - Date Artifact was last reviewed. In Unix Date Format |
@@ -1452,7 +1607,7 @@ For information at the command line use:
1452
1607
  ```
1453
1608
  $ bundle exec exe/emasser put artifacts help update
1454
1609
  ```
1455
- [top](#put)
1610
+ [top](#put-endpoints)
1456
1611
 
1457
1612
  ## Usage - DELETE
1458
1613
 
@@ -1463,9 +1618,9 @@ Remove one or many poa&m items in a system
1463
1618
 
1464
1619
  To remove (DELETE) one or more POA&M items use the following command:
1465
1620
  ```
1466
- bundle exec exe/emasser delete poams remove --systemId [value] --poamId [value]
1621
+ bundle exec exe/emasser delete poams remove -s, --systemId [value] -p, --poamId [value]
1467
1622
  ```
1468
- [top](#delete)
1623
+ [top](#delete-endpoints)
1469
1624
 
1470
1625
  ### ``delete milestones``
1471
1626
 
@@ -1480,9 +1635,9 @@ The last milestone can not be deleted, at-least on must exist.
1480
1635
 
1481
1636
  To remove (DELETE) one or more Milestones in a system use the following command:
1482
1637
  ```
1483
- bundle exec exe/emasser delete milestones remove--systemId [value] --poamId [value] --milestoneId [value]
1638
+ bundle exec exe/emasser delete milestones remove -s, --systemId [value] -p, --poamId [value] -m, --milestoneId [value]
1484
1639
  ```
1485
- [top](#delete)
1640
+ [top](#delete-endpoints)
1486
1641
 
1487
1642
  ### ``delete artifacts``
1488
1643
 
@@ -1493,10 +1648,30 @@ Provide single file or a space/comma delimited list of file names to be removed
1493
1648
 
1494
1649
  To remove (DELETE) one or more Artifacts from a system use the following command:
1495
1650
  ```
1496
- bundle exec exe/emasser delete artifacts remove --systemId [value] --files [value]
1651
+ bundle exec exe/emasser delete artifacts remove -s, --systemId [value] -f, --files [value]
1497
1652
  or
1498
- bundle exec exe/emasser delete artifacts remove --systemId [value] --files [value value...]
1653
+ bundle exec exe/emasser delete artifacts remove -s, --systemId [value] -f, --files [value value...]
1499
1654
  or
1500
- bundle exec exe/emasser delete artifacts remove --systemId [value] --files [value, value...]
1655
+ bundle exec exe/emasser delete artifacts remove -s, --systemId [value] -f, --files [value, value...]
1656
+ ```
1657
+ [top](#delete-endpoints)
1658
+
1659
+ ### ``delete cloud resource``
1660
+ ---
1661
+ Delete one or many Cloud Resources and their scan results in the assets module for a system
1662
+
1663
+ To remove (DELETE) one or many cloud resources in a system use the following command:
1664
+ ```
1665
+ bundle exec exe/emasser delete cloud_resource remove -c, --resourceId [value] -s, --systemId [value]
1666
+ ```
1667
+ [top](#delete-endpoints)
1668
+
1669
+ ### ``delete container``
1670
+ ---
1671
+ Delete one or many containers scan results in the assets module for a system
1672
+
1673
+ To remove (DELETE) one or many containers in a system use the following command:
1674
+ ```
1675
+ bundle exec exe/emasser delete container remove -c, --containerId [value] -s, --systemId [value]
1501
1676
  ```
1502
- [top](#delete)
1677
+ [top](#delete-endpoints)