emass_client 1.0.1 → 1.0.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (149) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +152 -1124
  3. data/Rakefile +2 -0
  4. data/lib/emass_client/api/artifacts_api.rb +124 -97
  5. data/lib/emass_client/api/artifacts_export_api.rb +28 -19
  6. data/lib/emass_client/api/cac_api.rb +50 -31
  7. data/lib/emass_client/api/cloud_resources_api.rb +96 -0
  8. data/lib/emass_client/api/cmmc_assessments_api.rb +20 -11
  9. data/lib/emass_client/api/containers_api.rb +96 -0
  10. data/lib/emass_client/api/controls_api.rb +53 -34
  11. data/lib/emass_client/api/milestones_api.rb +138 -92
  12. data/lib/emass_client/api/pac_api.rb +50 -31
  13. data/lib/emass_client/api/poam_api.rb +132 -86
  14. data/lib/emass_client/api/registration_api.rb +30 -18
  15. data/lib/emass_client/api/static_code_scans_api.rb +38 -26
  16. data/lib/emass_client/api/system_roles_api.rb +48 -29
  17. data/lib/emass_client/api/systems_api.rb +57 -39
  18. data/lib/emass_client/api/test_api.rb +20 -11
  19. data/lib/emass_client/api/test_results_api.rb +53 -34
  20. data/lib/emass_client/api/workflow_definitions_api.rb +23 -14
  21. data/lib/emass_client/api/workflow_instances_api.rb +58 -53
  22. data/lib/emass_client/api_client.rb +59 -57
  23. data/lib/emass_client/api_error.rb +5 -5
  24. data/lib/emass_client/configuration.rb +93 -16
  25. data/lib/emass_client/models/artifacts_get.rb +54 -31
  26. data/lib/emass_client/models/{artifacts_delete_inner.rb → artifacts_request_delete_body_inner.rb} +29 -16
  27. data/lib/emass_client/models/artifacts_response_del.rb +27 -14
  28. data/lib/emass_client/models/{artifacts_response_del_data.rb → artifacts_response_del_data_inner.rb} +31 -18
  29. data/lib/emass_client/models/artifacts_response_get.rb +27 -14
  30. data/lib/emass_client/models/artifacts_response_put_post.rb +27 -14
  31. data/lib/emass_client/models/artifacts_response_put_post_data_inner.rb +265 -0
  32. data/lib/emass_client/models/cac_get.rb +82 -50
  33. data/lib/emass_client/models/cac_response_get.rb +27 -14
  34. data/lib/emass_client/models/cac_response_post.rb +27 -14
  35. data/lib/emass_client/models/{cac_response_post_data.rb → cac_response_post_data_inner.rb} +61 -21
  36. data/lib/emass_client/models/{pac_request_post_body.rb → cloud_resources_post.rb} +73 -69
  37. data/lib/emass_client/models/cloud_resources_response_post.rb +230 -0
  38. data/lib/emass_client/models/cmmc_get.rb +53 -63
  39. data/lib/emass_client/models/cmmc_response_get.rb +27 -14
  40. data/lib/emass_client/models/connectivity_ccsd.rb +29 -14
  41. data/lib/emass_client/models/containers_resources_post.rb +265 -0
  42. data/lib/emass_client/models/containers_response_post.rb +230 -0
  43. data/lib/emass_client/models/controls_get.rb +103 -66
  44. data/lib/emass_client/models/controls_put.rb +58 -18
  45. data/lib/emass_client/models/controls_response_get.rb +28 -14
  46. data/lib/emass_client/models/controls_response_put.rb +27 -14
  47. data/lib/emass_client/models/definition_transitions.rb +32 -62
  48. data/lib/emass_client/models/instances_transitions.rb +37 -88
  49. data/lib/emass_client/models/milestone_response_get.rb +27 -14
  50. data/lib/emass_client/models/milestone_response_get_milestone.rb +228 -0
  51. data/lib/emass_client/models/milestone_response_post.rb +27 -14
  52. data/lib/emass_client/models/milestone_response_put.rb +27 -14
  53. data/lib/emass_client/models/milestones_get.rb +33 -20
  54. data/lib/emass_client/models/milestones_put_post_delete.rb +60 -20
  55. data/lib/emass_client/models/{delete_milestone.rb → milestones_request_delete_body_inner.rb} +29 -21
  56. data/lib/emass_client/models/milestones_required_post.rb +27 -14
  57. data/lib/emass_client/models/milestones_required_put.rb +28 -15
  58. data/lib/emass_client/models/pac_get.rb +39 -22
  59. data/lib/emass_client/models/pac_post.rb +60 -20
  60. data/lib/emass_client/models/pac_response_get.rb +28 -14
  61. data/lib/emass_client/models/pac_response_post.rb +27 -14
  62. data/lib/emass_client/models/poam_get.rb +114 -77
  63. data/lib/emass_client/models/poam_post_put_del.rb +59 -19
  64. data/lib/emass_client/models/{delete_poam.rb → poam_request_delete_body_inner.rb} +29 -21
  65. data/lib/emass_client/models/poam_response_delete.rb +27 -14
  66. data/lib/emass_client/models/poam_response_get_poams.rb +228 -0
  67. data/lib/emass_client/models/{static_code_required_post.rb → poam_response_get_systems.rb} +42 -29
  68. data/lib/emass_client/models/poam_response_post.rb +27 -14
  69. data/lib/emass_client/models/poam_response_put.rb +27 -14
  70. data/lib/emass_client/models/register.rb +27 -14
  71. data/lib/emass_client/models/register_data.rb +26 -13
  72. data/lib/emass_client/models/register_user_request_post_body.rb +26 -13
  73. data/lib/emass_client/models/{model_200.rb → response200.rb} +53 -16
  74. data/lib/emass_client/models/{model_400.rb → response201.rb} +29 -16
  75. data/lib/emass_client/models/{model_201_meta.rb → response201_meta.rb} +54 -17
  76. data/lib/emass_client/models/{model_400_response.rb → response400.rb} +29 -16
  77. data/lib/emass_client/models/{model_400_meta.rb → response400_meta.rb} +54 -17
  78. data/lib/emass_client/models/{model_401.rb → response401.rb} +29 -16
  79. data/lib/emass_client/models/{model_401_meta.rb → response401_meta.rb} +54 -17
  80. data/lib/emass_client/models/{model_201.rb → response403.rb} +29 -16
  81. data/lib/emass_client/models/{model_403_meta.rb → response403_meta.rb} +54 -17
  82. data/lib/emass_client/models/{model_404.rb → response404.rb} +54 -17
  83. data/lib/emass_client/models/response405.rb +219 -0
  84. data/lib/emass_client/models/{model_405_meta.rb → response405_meta.rb} +54 -17
  85. data/lib/emass_client/models/response411.rb +219 -0
  86. data/lib/emass_client/models/{model_411_meta.rb → response411_meta.rb} +54 -17
  87. data/lib/emass_client/models/response490.rb +219 -0
  88. data/lib/emass_client/models/{model_490_meta.rb → response490_meta.rb} +54 -17
  89. data/lib/emass_client/models/response500.rb +219 -0
  90. data/lib/emass_client/models/{model_500_meta.rb → response500_meta.rb} +54 -17
  91. data/lib/emass_client/models/role_category.rb +32 -50
  92. data/lib/emass_client/models/roles.rb +29 -61
  93. data/lib/emass_client/models/ssps.rb +32 -16
  94. data/lib/emass_client/models/stage.rb +30 -49
  95. data/lib/emass_client/models/static_code_application.rb +34 -33
  96. data/lib/emass_client/models/static_code_post.rb +275 -0
  97. data/lib/emass_client/models/static_code_request_post_body.rb +47 -14
  98. data/lib/emass_client/models/{static_code_required_post_application.rb → static_code_request_post_body_application.rb} +30 -17
  99. data/lib/emass_client/models/static_code_response_post.rb +230 -0
  100. data/lib/emass_client/models/success200_response.rb +27 -14
  101. data/lib/emass_client/models/{error.rb → success200_response_data_inner.rb} +57 -36
  102. data/lib/emass_client/models/system_response.rb +28 -17
  103. data/lib/emass_client/models/system_roles_category_response.rb +28 -14
  104. data/lib/emass_client/models/system_roles_response.rb +27 -14
  105. data/lib/emass_client/models/{system_roles_response_data.rb → system_roles_response_data_inner.rb} +30 -17
  106. data/lib/emass_client/models/systems.rb +218 -191
  107. data/lib/emass_client/models/{poam_response_get.rb → systems_response.rb} +30 -17
  108. data/lib/emass_client/models/test.rb +27 -14
  109. data/lib/emass_client/models/test_data.rb +26 -13
  110. data/lib/emass_client/models/test_results_get.rb +39 -35
  111. data/lib/emass_client/models/test_results_post.rb +58 -18
  112. data/lib/emass_client/models/test_results_response_get.rb +27 -14
  113. data/lib/emass_client/models/test_results_response_post.rb +27 -14
  114. data/lib/emass_client/models/users.rb +28 -15
  115. data/lib/emass_client/models/workflow_definition_get.rb +63 -68
  116. data/lib/emass_client/models/workflow_definition_response_get.rb +27 -14
  117. data/lib/emass_client/models/workflow_instance_get.rb +331 -0
  118. data/lib/emass_client/models/workflow_instance_response_get.rb +230 -0
  119. data/lib/emass_client/models/workflow_instances_get.rb +107 -133
  120. data/lib/emass_client/models/workflow_instances_response_get.rb +39 -17
  121. data/lib/emass_client/models/workflow_instances_response_get_pagination.rb +246 -0
  122. data/lib/emass_client/version.rb +6 -5
  123. data/lib/emass_client.rb +47 -54
  124. metadata +60 -89
  125. data/lib/emass_client/models/artifacts_delete.rb +0 -201
  126. data/lib/emass_client/models/artifacts_request_put_body.rb +0 -363
  127. data/lib/emass_client/models/cac_request_post_body.rb +0 -217
  128. data/lib/emass_client/models/controls_request_put_body.rb +0 -606
  129. data/lib/emass_client/models/empty200_response.rb +0 -197
  130. data/lib/emass_client/models/milestones_delete.rb +0 -197
  131. data/lib/emass_client/models/milestones_post.rb +0 -197
  132. data/lib/emass_client/models/milestones_put.rb +0 -197
  133. data/lib/emass_client/models/milestones_request_post_body.rb +0 -242
  134. data/lib/emass_client/models/milestones_request_put_body.rb +0 -242
  135. data/lib/emass_client/models/model_403.rb +0 -206
  136. data/lib/emass_client/models/model_404_response.rb +0 -206
  137. data/lib/emass_client/models/model_405.rb +0 -206
  138. data/lib/emass_client/models/model_411.rb +0 -206
  139. data/lib/emass_client/models/model_490.rb +0 -206
  140. data/lib/emass_client/models/model_500.rb +0 -206
  141. data/lib/emass_client/models/poam_delete.rb +0 -197
  142. data/lib/emass_client/models/poam_post.rb +0 -197
  143. data/lib/emass_client/models/poam_put.rb +0 -197
  144. data/lib/emass_client/models/poam_request_post_body.rb +0 -197
  145. data/lib/emass_client/models/poam_request_put_body.rb +0 -197
  146. data/lib/emass_client/models/poam_required_post.rb +0 -564
  147. data/lib/emass_client/models/poam_required_put.rb +0 -594
  148. data/lib/emass_client/models/system_id_artifacts_body.rb +0 -284
  149. data/lib/emass_client/models/test_results_request_post_body.rb +0 -306
data/README.md CHANGED
@@ -2,1112 +2,143 @@
2
2
 
3
3
  EmassClient - the Ruby gem for the Enterprise Mission Assurance Support Service (eMASS)
4
4
 
5
- The Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) enables users to perform assessments and complete actions associated with system records. The `emasser` is a command-line interface (CLI) tool that implements all of the eMASS endpoints defined in the eMASS REST API v3.2, dated October 21, 2021.</br><br> <strong>Register CLI</strong></br> New users will need to register an API key with the eMASS development team prior to accessing the site for the first time. The eMASS REST API requires a client certificate (SSL/TLS, DoD PKI only) where {url}/api/register (POST) is used to register the client certificate.</br></br> Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key. The API key must be provided in the request header for all endpoint calls (api-key). If the service receives an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br> <strong>Available Request Headers:</strong></br> <table> <tr> <th align=left>key</th> <th align=left>Example Value</th> <th align=left>Description</th> </tr> <tr> <td>`api-key`</td> <td>api-key-provided-by-emass</td> <td>This API key must be provided in the request header for all endpoint calls</td> </tr> <tr> <td>`user-uid`</td> <td>USER.UID.KEY</td> <td>This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls</td> </tr> <tr> <td></td><td></td> <td> Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC </td> </tr> </table> </br><strong>Approve API Client for Actionable Requests</strong></br> Users are required to log-in to eMASS and grant permissions for a client to update data within eMASS on their behalf. This is only required for actionable requests (PUT, POST, DELETE). The Registration Endpoint and all GET requests can be accessed without completing this process with the correct permissions. Please note that leaving a field parameter blank (for PUT/POST requests) has the potential to clear information in the active eMASS records. To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC:
6
-
7
- This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
-
9
- - API version: v3.2
10
- - Package version: 1.0.1
11
- - Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
12
- For more information, please visit [https://www.dcsa.mil/is/emass/](https://www.dcsa.mil/is/emass/)
13
-
14
- ## Installation
15
-
16
- ### Build a gem
17
-
18
- To build the Ruby code into a gem:
19
-
20
- ```shell
21
- gem build emass_client.gemspec
22
- ```
23
-
24
- Then either install the gem locally:
25
-
26
- ```shell
27
- gem install ./emass_client-1.0.1.gem
28
- ```
29
- (for development, run `gem install --dev ./emass_client-1.0.1.gem` to install the development dependencies)
30
-
31
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
-
33
- Finally add this to the Gemfile:
34
-
35
- gem 'emass_client', '~> 1.0.1'
36
-
37
- ### Install from Git
38
-
39
- If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
40
-
41
- gem 'emass_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
42
-
43
- ### Include the Ruby code directly
44
-
45
- Include the Ruby code directly using `-I` as follows:
46
-
47
- ```shell
48
- ruby -Ilib script.rb
49
- ```
50
-
51
- ## Getting Started
52
-
53
- Please follow the [installation](#installation) procedure and then run the following code:
54
- ```ruby
55
- # Load the gem
56
- require 'emass_client'
57
- # Setup authorization
58
- EmassClient.configure do |config|
59
- # Configure API key authorization: apikey
60
- config.api_key['api-key'] = 'YOUR API KEY'
61
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
62
- #config.api_key_prefix['api-key'] = 'Bearer'
63
-
64
- # Configure API key authorization: mockType
65
- config.api_key['Prefer'] = 'YOUR API KEY'
66
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
67
- #config.api_key_prefix['Prefer'] = 'Bearer'
68
-
69
- # Configure API key authorization: userid
70
- config.api_key['user-uid'] = 'YOUR API KEY'
71
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
72
- #config.api_key_prefix['user-uid'] = 'Bearer'
73
- end
74
-
75
- api_instance = EmassClient::ArtifactsApi.new
76
- is_template = true # BOOLEAN |
77
- type = 'type_example' # String |
78
- category = 'category_example' # String |
79
- zipper = 'zipper_example' # String |
80
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
81
-
82
-
83
- begin
84
- #Add one or many artifacts in a system
85
- result = api_instance.add_artifacts_by_system_id(is_template, type, category, zipper, system_id)
86
- p result
87
- rescue EmassClient::ApiError => e
88
- puts "Exception when calling ArtifactsApi->add_artifacts_by_system_id: #{e}"
89
- end
90
- # Setup authorization
91
- EmassClient.configure do |config|
92
- # Configure API key authorization: apikey
93
- config.api_key['api-key'] = 'YOUR API KEY'
94
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
95
- #config.api_key_prefix['api-key'] = 'Bearer'
96
-
97
- # Configure API key authorization: mockType
98
- config.api_key['Prefer'] = 'YOUR API KEY'
99
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
100
- #config.api_key_prefix['Prefer'] = 'Bearer'
101
-
102
- # Configure API key authorization: userid
103
- config.api_key['user-uid'] = 'YOUR API KEY'
104
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
105
- #config.api_key_prefix['user-uid'] = 'Bearer'
106
- end
107
-
108
- api_instance = EmassClient::ArtifactsApi.new
109
- body = [EmassClient::ArtifactsDeleteInner.new] # Array<ArtifactsDeleteInner> | See notes above for additional information
110
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
111
-
112
-
113
- begin
114
- #Remove one or many artifacts in a system
115
- result = api_instance.delete_artifact(body, system_id)
116
- p result
117
- rescue EmassClient::ApiError => e
118
- puts "Exception when calling ArtifactsApi->delete_artifact: #{e}"
119
- end
120
- # Setup authorization
121
- EmassClient.configure do |config|
122
- # Configure API key authorization: apikey
123
- config.api_key['api-key'] = 'YOUR API KEY'
124
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
125
- #config.api_key_prefix['api-key'] = 'Bearer'
126
-
127
- # Configure API key authorization: mockType
128
- config.api_key['Prefer'] = 'YOUR API KEY'
129
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
130
- #config.api_key_prefix['Prefer'] = 'Bearer'
131
-
132
- # Configure API key authorization: userid
133
- config.api_key['user-uid'] = 'YOUR API KEY'
134
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
135
- #config.api_key_prefix['user-uid'] = 'Bearer'
136
- end
137
-
138
- api_instance = EmassClient::ArtifactsApi.new
139
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
140
- opts = {
141
- filename: 'filename_example', # String | **File Name**: The file name (to include file-extension).
142
- control_acronyms: 'control_acronyms_example', # String | **System Acronym**: Filter query by given system acronym (single or comma separated).
143
- ccis: 'ccis_example', # String | **CCI System**: Filter query by Control Correlation Identifiers (CCIs).
144
- system_only: true # BOOLEAN | **Systems Only**: Indicates that only system(s) information is retrieved.
145
- }
146
-
147
- begin
148
- #Get one or many artifacts in a system
149
- result = api_instance.get_system_artifacts(system_id, opts)
150
- p result
151
- rescue EmassClient::ApiError => e
152
- puts "Exception when calling ArtifactsApi->get_system_artifacts: #{e}"
153
- end
154
- # Setup authorization
155
- EmassClient.configure do |config|
156
- # Configure API key authorization: apikey
157
- config.api_key['api-key'] = 'YOUR API KEY'
158
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
159
- #config.api_key_prefix['api-key'] = 'Bearer'
160
-
161
- # Configure API key authorization: mockType
162
- config.api_key['Prefer'] = 'YOUR API KEY'
163
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
164
- #config.api_key_prefix['Prefer'] = 'Bearer'
165
-
166
- # Configure API key authorization: userid
167
- config.api_key['user-uid'] = 'YOUR API KEY'
168
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
169
- #config.api_key_prefix['user-uid'] = 'Bearer'
170
- end
171
-
172
- api_instance = EmassClient::ArtifactsApi.new
173
- body = EmassClient::ArtifactsRequestPutBody.new # ArtifactsRequestPutBody | See `information` above for additional instructions
174
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
175
-
176
-
177
- begin
178
- #Update one or many artifacts in a system
179
- result = api_instance.update_artifact_by_system_id(body, system_id)
180
- p result
181
- rescue EmassClient::ApiError => e
182
- puts "Exception when calling ArtifactsApi->update_artifact_by_system_id: #{e}"
183
- end
184
- # Setup authorization
185
- EmassClient.configure do |config|
186
- # Configure API key authorization: apikey
187
- config.api_key['api-key'] = 'YOUR API KEY'
188
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
189
- #config.api_key_prefix['api-key'] = 'Bearer'
190
-
191
- # Configure API key authorization: mockType
192
- config.api_key['Prefer'] = 'YOUR API KEY'
193
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
194
- #config.api_key_prefix['Prefer'] = 'Bearer'
195
-
196
- # Configure API key authorization: userid
197
- config.api_key['user-uid'] = 'YOUR API KEY'
198
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
199
- #config.api_key_prefix['user-uid'] = 'Bearer'
200
- end
201
-
202
- api_instance = EmassClient::ArtifactsExportApi.new
203
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
204
- filename = 'filename_example' # String | **File Name**: The file name (to include file-extension).
205
- opts = {
206
- compress: true # BOOLEAN | **Compress File**: Determines if returned file is compressed.
207
- }
208
-
209
- begin
210
- #Get the file of an artifact in a system
211
- result = api_instance.get_system_artifacts_export(system_id, filename, opts)
212
- p result
213
- rescue EmassClient::ApiError => e
214
- puts "Exception when calling ArtifactsExportApi->get_system_artifacts_export: #{e}"
215
- end
216
- # Setup authorization
217
- EmassClient.configure do |config|
218
- # Configure API key authorization: apikey
219
- config.api_key['api-key'] = 'YOUR API KEY'
220
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
221
- #config.api_key_prefix['api-key'] = 'Bearer'
222
-
223
- # Configure API key authorization: mockType
224
- config.api_key['Prefer'] = 'YOUR API KEY'
225
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
226
- #config.api_key_prefix['Prefer'] = 'Bearer'
227
-
228
- # Configure API key authorization: userid
229
- config.api_key['user-uid'] = 'YOUR API KEY'
230
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
231
- #config.api_key_prefix['user-uid'] = 'Bearer'
232
- end
233
-
234
- api_instance = EmassClient::CACApi.new
235
- body = EmassClient::CacRequestPostBody.new # CacRequestPostBody | Update an existing Artifact by Id
236
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
237
-
238
-
239
- begin
240
- #Submit control to second role of CAC
241
- result = api_instance.add_system_cac(body, system_id)
242
- p result
243
- rescue EmassClient::ApiError => e
244
- puts "Exception when calling CACApi->add_system_cac: #{e}"
245
- end
246
- # Setup authorization
247
- EmassClient.configure do |config|
248
- # Configure API key authorization: apikey
249
- config.api_key['api-key'] = 'YOUR API KEY'
250
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
251
- #config.api_key_prefix['api-key'] = 'Bearer'
252
-
253
- # Configure API key authorization: mockType
254
- config.api_key['Prefer'] = 'YOUR API KEY'
255
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
256
- #config.api_key_prefix['Prefer'] = 'Bearer'
257
-
258
- # Configure API key authorization: userid
259
- config.api_key['user-uid'] = 'YOUR API KEY'
260
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
261
- #config.api_key_prefix['user-uid'] = 'Bearer'
262
- end
263
-
264
- api_instance = EmassClient::CACApi.new
265
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
266
- opts = {
267
- control_acronyms: 'control_acronyms_example' # String | **System Acronym**: Filter query by given system acronym (single or comma separated).
268
- }
269
-
270
- begin
271
- #Get location of one or many controls in CAC
272
- result = api_instance.get_system_cac(system_id, opts)
273
- p result
274
- rescue EmassClient::ApiError => e
275
- puts "Exception when calling CACApi->get_system_cac: #{e}"
276
- end
277
- # Setup authorization
278
- EmassClient.configure do |config|
279
- # Configure API key authorization: apikey
280
- config.api_key['api-key'] = 'YOUR API KEY'
281
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
282
- #config.api_key_prefix['api-key'] = 'Bearer'
283
-
284
- # Configure API key authorization: mockType
285
- config.api_key['Prefer'] = 'YOUR API KEY'
286
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
287
- #config.api_key_prefix['Prefer'] = 'Bearer'
288
-
289
- # Configure API key authorization: userid
290
- config.api_key['user-uid'] = 'YOUR API KEY'
291
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
292
- #config.api_key_prefix['user-uid'] = 'Bearer'
293
- end
294
-
295
- api_instance = EmassClient::CMMCAssessmentsApi.new
296
- since_date = 'since_date_example' # String | **Date** CMMC date (Unix date format)
297
-
298
-
299
- begin
300
- #Get CMMC assessment information
301
- result = api_instance.get_cmmc_assessments(since_date)
302
- p result
303
- rescue EmassClient::ApiError => e
304
- puts "Exception when calling CMMCAssessmentsApi->get_cmmc_assessments: #{e}"
305
- end
306
- # Setup authorization
307
- EmassClient.configure do |config|
308
- # Configure API key authorization: apikey
309
- config.api_key['api-key'] = 'YOUR API KEY'
310
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
311
- #config.api_key_prefix['api-key'] = 'Bearer'
312
-
313
- # Configure API key authorization: mockType
314
- config.api_key['Prefer'] = 'YOUR API KEY'
315
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
316
- #config.api_key_prefix['Prefer'] = 'Bearer'
317
-
318
- # Configure API key authorization: userid
319
- config.api_key['user-uid'] = 'YOUR API KEY'
320
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
321
- #config.api_key_prefix['user-uid'] = 'Bearer'
322
- end
323
-
324
- api_instance = EmassClient::ControlsApi.new
325
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
326
- opts = {
327
- acronyms: 'PM-6' # String | **Acronym**: The system acronym(s) being queried (single value or comma delimited values).
328
- }
329
-
330
- begin
331
- #Get control information in a system for one or many controls
332
- result = api_instance.get_system_controls(system_id, opts)
333
- p result
334
- rescue EmassClient::ApiError => e
335
- puts "Exception when calling ControlsApi->get_system_controls: #{e}"
336
- end
337
- # Setup authorization
338
- EmassClient.configure do |config|
339
- # Configure API key authorization: apikey
340
- config.api_key['api-key'] = 'YOUR API KEY'
341
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
342
- #config.api_key_prefix['api-key'] = 'Bearer'
343
-
344
- # Configure API key authorization: mockType
345
- config.api_key['Prefer'] = 'YOUR API KEY'
346
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
347
- #config.api_key_prefix['Prefer'] = 'Bearer'
348
-
349
- # Configure API key authorization: userid
350
- config.api_key['user-uid'] = 'YOUR API KEY'
351
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
352
- #config.api_key_prefix['user-uid'] = 'Bearer'
353
- end
354
-
355
- api_instance = EmassClient::ControlsApi.new
356
- body = EmassClient::ControlsRequestPutBody.new # ControlsRequestPutBody | Update an existing control by Id
357
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
358
-
359
-
360
- begin
361
- #Update control information in a system for one or many controls
362
- result = api_instance.update_control_by_system_id(body, system_id)
363
- p result
364
- rescue EmassClient::ApiError => e
365
- puts "Exception when calling ControlsApi->update_control_by_system_id: #{e}"
366
- end
367
- # Setup authorization
368
- EmassClient.configure do |config|
369
- # Configure API key authorization: apikey
370
- config.api_key['api-key'] = 'YOUR API KEY'
371
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
372
- #config.api_key_prefix['api-key'] = 'Bearer'
373
-
374
- # Configure API key authorization: mockType
375
- config.api_key['Prefer'] = 'YOUR API KEY'
376
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
377
- #config.api_key_prefix['Prefer'] = 'Bearer'
378
-
379
- # Configure API key authorization: userid
380
- config.api_key['user-uid'] = 'YOUR API KEY'
381
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
382
- #config.api_key_prefix['user-uid'] = 'Bearer'
383
- end
384
-
385
- api_instance = EmassClient::MilestonesApi.new
386
- body = EmassClient::MilestonesRequestPostBody.new # MilestonesRequestPostBody | Update an existing milestone
387
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
388
- poam_id = 56 # Integer | **POA&M Id**: The unique POA&M record identifier.
389
-
390
-
391
- begin
392
- #Add milestones to one or many POA&M items in a system
393
- result = api_instance.add_milestone_by_system_id_and_poam_id(body, system_id, poam_id)
394
- p result
395
- rescue EmassClient::ApiError => e
396
- puts "Exception when calling MilestonesApi->add_milestone_by_system_id_and_poam_id: #{e}"
397
- end
398
- # Setup authorization
399
- EmassClient.configure do |config|
400
- # Configure API key authorization: apikey
401
- config.api_key['api-key'] = 'YOUR API KEY'
402
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
403
- #config.api_key_prefix['api-key'] = 'Bearer'
404
-
405
- # Configure API key authorization: mockType
406
- config.api_key['Prefer'] = 'YOUR API KEY'
407
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
408
- #config.api_key_prefix['Prefer'] = 'Bearer'
409
-
410
- # Configure API key authorization: userid
411
- config.api_key['user-uid'] = 'YOUR API KEY'
412
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
413
- #config.api_key_prefix['user-uid'] = 'Bearer'
414
- end
415
-
416
- api_instance = EmassClient::MilestonesApi.new
417
- body = EmassClient::DeleteMilestone.new # DeleteMilestone | Delete the given Milestone Id
418
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
419
- poam_id = 56 # Integer | **POA&M Id**: The unique POA&M record identifier.
420
-
421
-
422
- begin
423
- #Remove milestones in a system for one or many POA&M items
424
- result = api_instance.delete_milestone(body, system_id, poam_id)
425
- p result
426
- rescue EmassClient::ApiError => e
427
- puts "Exception when calling MilestonesApi->delete_milestone: #{e}"
428
- end
429
- # Setup authorization
430
- EmassClient.configure do |config|
431
- # Configure API key authorization: apikey
432
- config.api_key['api-key'] = 'YOUR API KEY'
433
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
434
- #config.api_key_prefix['api-key'] = 'Bearer'
435
-
436
- # Configure API key authorization: mockType
437
- config.api_key['Prefer'] = 'YOUR API KEY'
438
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
439
- #config.api_key_prefix['Prefer'] = 'Bearer'
440
-
441
- # Configure API key authorization: userid
442
- config.api_key['user-uid'] = 'YOUR API KEY'
443
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
444
- #config.api_key_prefix['user-uid'] = 'Bearer'
445
- end
446
-
447
- api_instance = EmassClient::MilestonesApi.new
448
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
449
- poam_id = 56 # Integer | **POA&M Id**: The unique POA&M record identifier.
450
- opts = {
451
- scheduled_completion_date_start: 'scheduled_completion_date_start_example', # String | **Date Started**: Filter query by the scheduled completion start date (Unix date format).
452
- scheduled_completion_date_end: 'scheduled_completion_date_end_example' # String | **Date Ended**: Filter query by the scheduled completion start date (Unix date format).
453
- }
454
-
455
- begin
456
- #Get milestones in one or many POA&M items in a system
457
- result = api_instance.get_system_milestones_by_poam_id(system_id, poam_id, opts)
458
- p result
459
- rescue EmassClient::ApiError => e
460
- puts "Exception when calling MilestonesApi->get_system_milestones_by_poam_id: #{e}"
461
- end
462
- # Setup authorization
463
- EmassClient.configure do |config|
464
- # Configure API key authorization: apikey
465
- config.api_key['api-key'] = 'YOUR API KEY'
466
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
467
- #config.api_key_prefix['api-key'] = 'Bearer'
468
-
469
- # Configure API key authorization: mockType
470
- config.api_key['Prefer'] = 'YOUR API KEY'
471
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
472
- #config.api_key_prefix['Prefer'] = 'Bearer'
473
-
474
- # Configure API key authorization: userid
475
- config.api_key['user-uid'] = 'YOUR API KEY'
476
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
477
- #config.api_key_prefix['user-uid'] = 'Bearer'
478
- end
479
-
480
- api_instance = EmassClient::MilestonesApi.new
481
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
482
- poam_id = 56 # Integer | **POA&M Id**: The unique POA&M record identifier.
483
- milestone_id = 56 # Integer | **Milestone Id**: The unique milestone record identifier.
484
-
485
-
486
- begin
487
- #Get milestone by ID in POA&M item in a system
488
- result = api_instance.get_system_milestones_by_poam_id_and_milestone_id(system_id, poam_id, milestone_id)
489
- p result
490
- rescue EmassClient::ApiError => e
491
- puts "Exception when calling MilestonesApi->get_system_milestones_by_poam_id_and_milestone_id: #{e}"
492
- end
493
- # Setup authorization
494
- EmassClient.configure do |config|
495
- # Configure API key authorization: apikey
496
- config.api_key['api-key'] = 'YOUR API KEY'
497
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
498
- #config.api_key_prefix['api-key'] = 'Bearer'
499
-
500
- # Configure API key authorization: mockType
501
- config.api_key['Prefer'] = 'YOUR API KEY'
502
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
503
- #config.api_key_prefix['Prefer'] = 'Bearer'
504
-
505
- # Configure API key authorization: userid
506
- config.api_key['user-uid'] = 'YOUR API KEY'
507
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
508
- #config.api_key_prefix['user-uid'] = 'Bearer'
509
- end
510
-
511
- api_instance = EmassClient::MilestonesApi.new
512
- body = EmassClient::MilestonesRequestPutBody.new # MilestonesRequestPutBody | Update an existing control by Id
513
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
514
- poam_id = 56 # Integer | **POA&M Id**: The unique POA&M record identifier.
515
-
516
-
517
- begin
518
- #Update one or many POA&M items in a system
519
- result = api_instance.update_milestone_by_system_id_and_poam_id(body, system_id, poam_id)
520
- p result
521
- rescue EmassClient::ApiError => e
522
- puts "Exception when calling MilestonesApi->update_milestone_by_system_id_and_poam_id: #{e}"
523
- end
524
- # Setup authorization
525
- EmassClient.configure do |config|
526
- # Configure API key authorization: apikey
527
- config.api_key['api-key'] = 'YOUR API KEY'
528
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
529
- #config.api_key_prefix['api-key'] = 'Bearer'
530
-
531
- # Configure API key authorization: mockType
532
- config.api_key['Prefer'] = 'YOUR API KEY'
533
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
534
- #config.api_key_prefix['Prefer'] = 'Bearer'
535
-
536
- # Configure API key authorization: userid
537
- config.api_key['user-uid'] = 'YOUR API KEY'
538
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
539
- #config.api_key_prefix['user-uid'] = 'Bearer'
540
- end
541
-
542
- api_instance = EmassClient::PACApi.new
543
- body = EmassClient::PacRequestPostBody.new # PacRequestPostBody | Update an existing Artifact by Id
544
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
545
-
546
-
547
- begin
548
- #Submit system package for review
549
- result = api_instance.add_system_pac(body, system_id)
550
- p result
551
- rescue EmassClient::ApiError => e
552
- puts "Exception when calling PACApi->add_system_pac: #{e}"
553
- end
554
- # Setup authorization
555
- EmassClient.configure do |config|
556
- # Configure API key authorization: apikey
557
- config.api_key['api-key'] = 'YOUR API KEY'
558
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
559
- #config.api_key_prefix['api-key'] = 'Bearer'
560
-
561
- # Configure API key authorization: mockType
562
- config.api_key['Prefer'] = 'YOUR API KEY'
563
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
564
- #config.api_key_prefix['Prefer'] = 'Bearer'
565
-
566
- # Configure API key authorization: userid
567
- config.api_key['user-uid'] = 'YOUR API KEY'
568
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
569
- #config.api_key_prefix['user-uid'] = 'Bearer'
570
- end
571
-
572
- api_instance = EmassClient::PACApi.new
573
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
574
-
575
-
576
- begin
577
- #Get location of system package in PAC
578
- result = api_instance.get_system_pac(system_id)
579
- p result
580
- rescue EmassClient::ApiError => e
581
- puts "Exception when calling PACApi->get_system_pac: #{e}"
582
- end
583
- # Setup authorization
584
- EmassClient.configure do |config|
585
- # Configure API key authorization: apikey
586
- config.api_key['api-key'] = 'YOUR API KEY'
587
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
588
- #config.api_key_prefix['api-key'] = 'Bearer'
589
-
590
- # Configure API key authorization: mockType
591
- config.api_key['Prefer'] = 'YOUR API KEY'
592
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
593
- #config.api_key_prefix['Prefer'] = 'Bearer'
594
-
595
- # Configure API key authorization: userid
596
- config.api_key['user-uid'] = 'YOUR API KEY'
597
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
598
- #config.api_key_prefix['user-uid'] = 'Bearer'
599
- end
600
-
601
- api_instance = EmassClient::POAMApi.new
602
- body = EmassClient::PoamRequiredPost.new # PoamRequiredPost | Update an existing control by Id
603
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
604
-
605
-
606
- begin
607
- #Add one or many POA&M items in a system
608
- result = api_instance.add_poam_by_system_id(body, system_id)
609
- p result
610
- rescue EmassClient::ApiError => e
611
- puts "Exception when calling POAMApi->add_poam_by_system_id: #{e}"
612
- end
613
- # Setup authorization
614
- EmassClient.configure do |config|
615
- # Configure API key authorization: apikey
616
- config.api_key['api-key'] = 'YOUR API KEY'
617
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
618
- #config.api_key_prefix['api-key'] = 'Bearer'
619
-
620
- # Configure API key authorization: mockType
621
- config.api_key['Prefer'] = 'YOUR API KEY'
622
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
623
- #config.api_key_prefix['Prefer'] = 'Bearer'
624
-
625
- # Configure API key authorization: userid
626
- config.api_key['user-uid'] = 'YOUR API KEY'
627
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
628
- #config.api_key_prefix['user-uid'] = 'Bearer'
629
- end
630
-
631
- api_instance = EmassClient::POAMApi.new
632
- body = EmassClient::DeletePoam.new # DeletePoam | Delete the given POA&M Id
633
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
634
-
635
-
636
- begin
637
- #Remove one or many POA&M items in a system
638
- result = api_instance.delete_poam(body, system_id)
639
- p result
640
- rescue EmassClient::ApiError => e
641
- puts "Exception when calling POAMApi->delete_poam: #{e}"
642
- end
643
- # Setup authorization
644
- EmassClient.configure do |config|
645
- # Configure API key authorization: apikey
646
- config.api_key['api-key'] = 'YOUR API KEY'
647
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
648
- #config.api_key_prefix['api-key'] = 'Bearer'
649
-
650
- # Configure API key authorization: mockType
651
- config.api_key['Prefer'] = 'YOUR API KEY'
652
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
653
- #config.api_key_prefix['Prefer'] = 'Bearer'
654
-
655
- # Configure API key authorization: userid
656
- config.api_key['user-uid'] = 'YOUR API KEY'
657
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
658
- #config.api_key_prefix['user-uid'] = 'Bearer'
659
- end
660
-
661
- api_instance = EmassClient::POAMApi.new
662
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
663
- opts = {
664
- scheduled_completion_date_start: 'scheduled_completion_date_start_example', # String | **Date Started**: Filter query by the scheduled completion start date (Unix date format).
665
- scheduled_completion_date_end: 'scheduled_completion_date_end_example', # String | **Date Ended**: Filter query by the scheduled completion start date (Unix date format).
666
- control_acronyms: 'control_acronyms_example', # String | **System Acronym**: Filter query by given system acronym (single or comma separated).
667
- ccis: 'ccis_example', # String | **CCI System**: Filter query by Control Correlation Identifiers (CCIs).
668
- system_only: true # BOOLEAN | **Systems Only**: Indicates that only system(s) information is retrieved.
669
- }
670
-
671
- begin
672
- #Get one or many POA&M items in a system
673
- result = api_instance.get_system_poams(system_id, opts)
674
- p result
675
- rescue EmassClient::ApiError => e
676
- puts "Exception when calling POAMApi->get_system_poams: #{e}"
677
- end
678
- # Setup authorization
679
- EmassClient.configure do |config|
680
- # Configure API key authorization: apikey
681
- config.api_key['api-key'] = 'YOUR API KEY'
682
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
683
- #config.api_key_prefix['api-key'] = 'Bearer'
684
-
685
- # Configure API key authorization: mockType
686
- config.api_key['Prefer'] = 'YOUR API KEY'
687
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
688
- #config.api_key_prefix['Prefer'] = 'Bearer'
689
-
690
- # Configure API key authorization: userid
691
- config.api_key['user-uid'] = 'YOUR API KEY'
692
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
693
- #config.api_key_prefix['user-uid'] = 'Bearer'
694
- end
695
-
696
- api_instance = EmassClient::POAMApi.new
697
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
698
- poam_id = 56 # Integer | **POA&M Id**: The unique POA&M record identifier.
699
-
700
-
701
- begin
702
- #Get POA&M item by ID in a system
703
- result = api_instance.get_system_poams_by_poam_id(system_id, poam_id)
704
- p result
705
- rescue EmassClient::ApiError => e
706
- puts "Exception when calling POAMApi->get_system_poams_by_poam_id: #{e}"
707
- end
708
- # Setup authorization
709
- EmassClient.configure do |config|
710
- # Configure API key authorization: apikey
711
- config.api_key['api-key'] = 'YOUR API KEY'
712
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
713
- #config.api_key_prefix['api-key'] = 'Bearer'
714
-
715
- # Configure API key authorization: mockType
716
- config.api_key['Prefer'] = 'YOUR API KEY'
717
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
718
- #config.api_key_prefix['Prefer'] = 'Bearer'
719
-
720
- # Configure API key authorization: userid
721
- config.api_key['user-uid'] = 'YOUR API KEY'
722
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
723
- #config.api_key_prefix['user-uid'] = 'Bearer'
724
- end
725
-
726
- api_instance = EmassClient::POAMApi.new
727
- body = EmassClient::PoamRequiredPut.new # PoamRequiredPut | Update an existing control by Id
728
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
729
-
730
-
731
- begin
732
- #Update one or many POA&M items in a system
733
- result = api_instance.update_poam_by_system_id(body, system_id)
734
- p result
735
- rescue EmassClient::ApiError => e
736
- puts "Exception when calling POAMApi->update_poam_by_system_id: #{e}"
737
- end
738
- # Setup authorization
739
- EmassClient.configure do |config|
740
- # Configure API key authorization: apikey
741
- config.api_key['api-key'] = 'YOUR API KEY'
742
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
743
- #config.api_key_prefix['api-key'] = 'Bearer'
744
-
745
- # Configure API key authorization: mockType
746
- config.api_key['Prefer'] = 'YOUR API KEY'
747
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
748
- #config.api_key_prefix['Prefer'] = 'Bearer'
749
-
750
- # Configure API key authorization: userid
751
- config.api_key['user-uid'] = 'YOUR API KEY'
752
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
753
- #config.api_key_prefix['user-uid'] = 'Bearer'
754
- end
755
-
756
- api_instance = EmassClient::RegistrationApi.new
757
- body = EmassClient::RegisterUserRequestPostBody.new # RegisterUserRequestPostBody | User certificate previously provided by eMASS.
758
-
759
-
760
- begin
761
- #Register user certificate and obtain an API key
762
- result = api_instance.register_user(body)
763
- p result
764
- rescue EmassClient::ApiError => e
765
- puts "Exception when calling RegistrationApi->register_user: #{e}"
766
- end
767
- # Setup authorization
768
- EmassClient.configure do |config|
769
- # Configure API key authorization: apikey
770
- config.api_key['api-key'] = 'YOUR API KEY'
771
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
772
- #config.api_key_prefix['api-key'] = 'Bearer'
773
-
774
- # Configure API key authorization: mockType
775
- config.api_key['Prefer'] = 'YOUR API KEY'
776
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
777
- #config.api_key_prefix['Prefer'] = 'Bearer'
778
-
779
- # Configure API key authorization: userid
780
- config.api_key['user-uid'] = 'YOUR API KEY'
781
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
782
- #config.api_key_prefix['user-uid'] = 'Bearer'
783
- end
784
-
785
- api_instance = EmassClient::StaticCodeScansApi.new
786
- body = EmassClient::StaticCodeRequiredPost.new # StaticCodeRequiredPost | Update an existing Artifact by Id
787
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
788
-
789
-
790
- begin
791
- #Upload static code scans or Clear static code scans
792
- result = api_instance.add_static_code_scans_by_system_id(body, system_id)
793
- p result
794
- rescue EmassClient::ApiError => e
795
- puts "Exception when calling StaticCodeScansApi->add_static_code_scans_by_system_id: #{e}"
796
- end
797
- # Setup authorization
798
- EmassClient.configure do |config|
799
- # Configure API key authorization: apikey
800
- config.api_key['api-key'] = 'YOUR API KEY'
801
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
802
- #config.api_key_prefix['api-key'] = 'Bearer'
803
-
804
- # Configure API key authorization: mockType
805
- config.api_key['Prefer'] = 'YOUR API KEY'
806
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
807
- #config.api_key_prefix['Prefer'] = 'Bearer'
808
-
809
- # Configure API key authorization: userid
810
- config.api_key['user-uid'] = 'YOUR API KEY'
811
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
812
- #config.api_key_prefix['user-uid'] = 'Bearer'
813
- end
814
-
815
- api_instance = EmassClient::SystemRolesApi.new
816
-
817
- begin
818
- #Get available roles
819
- result = api_instance.get_system_roles
820
- p result
821
- rescue EmassClient::ApiError => e
822
- puts "Exception when calling SystemRolesApi->get_system_roles: #{e}"
823
- end
824
- # Setup authorization
825
- EmassClient.configure do |config|
826
- # Configure API key authorization: apikey
827
- config.api_key['api-key'] = 'YOUR API KEY'
828
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
829
- #config.api_key_prefix['api-key'] = 'Bearer'
830
-
831
- # Configure API key authorization: mockType
832
- config.api_key['Prefer'] = 'YOUR API KEY'
833
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
834
- #config.api_key_prefix['Prefer'] = 'Bearer'
835
-
836
- # Configure API key authorization: userid
837
- config.api_key['user-uid'] = 'YOUR API KEY'
838
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
839
- #config.api_key_prefix['user-uid'] = 'Bearer'
840
- end
841
-
842
- api_instance = EmassClient::SystemRolesApi.new
843
- role_category = 'role_category_example' # String | **Role Category**: The system role category been queried
844
- role = 'IAO' # String | **Role**: Accepts single value from options available at base system-roles endpoint e.g., SCA.
845
- opts = {
846
- policy: 'rmf', # String | **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information.
847
- include_decommissioned: true # BOOLEAN | **Include Decommissioned Systems**: Indicates if decommissioned systems are retrieved. If no value is specified, the default returns true to include decommissioned systems.
848
- }
849
-
850
- begin
851
- #Get system roles
852
- result = api_instance.get_system_roles_by_category_id(role_category, role, opts)
853
- p result
854
- rescue EmassClient::ApiError => e
855
- puts "Exception when calling SystemRolesApi->get_system_roles_by_category_id: #{e}"
856
- end
857
- # Setup authorization
858
- EmassClient.configure do |config|
859
- # Configure API key authorization: apikey
860
- config.api_key['api-key'] = 'YOUR API KEY'
861
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
862
- #config.api_key_prefix['api-key'] = 'Bearer'
863
-
864
- # Configure API key authorization: mockType
865
- config.api_key['Prefer'] = 'YOUR API KEY'
866
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
867
- #config.api_key_prefix['Prefer'] = 'Bearer'
868
-
869
- # Configure API key authorization: userid
870
- config.api_key['user-uid'] = 'YOUR API KEY'
871
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
872
- #config.api_key_prefix['user-uid'] = 'Bearer'
873
- end
874
-
875
- api_instance = EmassClient::SystemsApi.new
876
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
877
- opts = {
878
- include_package: true, # BOOLEAN | **Include Package**: Indicates if additional packages information is retrieved for queried system.
879
- policy: 'rmf' # String | **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information.
880
- }
881
-
882
- begin
883
- #Get system information for a specific system
884
- result = api_instance.get_system(system_id, opts)
885
- p result
886
- rescue EmassClient::ApiError => e
887
- puts "Exception when calling SystemsApi->get_system: #{e}"
888
- end
889
- # Setup authorization
890
- EmassClient.configure do |config|
891
- # Configure API key authorization: apikey
892
- config.api_key['api-key'] = 'YOUR API KEY'
893
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
894
- #config.api_key_prefix['api-key'] = 'Bearer'
895
-
896
- # Configure API key authorization: mockType
897
- config.api_key['Prefer'] = 'YOUR API KEY'
898
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
899
- #config.api_key_prefix['Prefer'] = 'Bearer'
5
+ The Enterprise Mission Assurance Support Service (eMASS) Representational State
6
+ Transfer (REST) Application Programming Interface (API) enables users to perform
7
+ assessments and complete actions associated with system records.
8
+
9
+ <strong>Register External Application (that use the eMASS API)</strong></br>
10
+ New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf)
11
+ an API key with the eMASS development team prior to accessing the site for the first time. The eMASS REST API
12
+ requires a client certificate (SSL/TLS, DoD PKI only). Use the `Registration` endpoint to register the client
13
+ certificate.</br></br>
14
+
15
+ Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key.
16
+ The API key must be provided in the request header for all endpoint calls (api-key). If the service receives
17
+ an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br>
18
+
19
+ <strong>Available Request Headers</strong></br>
20
+ <table>
21
+ <tr>
22
+ <th align=left>key</th>
23
+ <th align=left>Example Value</th>
24
+ <th align=left>Description</th>
25
+ </tr>
26
+ <tr>
27
+ <td>`api-key`</td>
28
+ <td>api-key-provided-by-emass</td>
29
+ <td>This API key must be provided in the request header for all endpoint calls</td>
30
+ </tr>
31
+ <tr>
32
+ <td>`user-uid`</td>
33
+ <td>USER.UID.KEY</td>
34
+ <td>This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls</td>
35
+ </tr>
36
+ <tr>
37
+ <td></td><td></td>
38
+ <td>
39
+ Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC
40
+ </td>
41
+ </tr>
42
+ </table>
43
+
44
+ </br><strong>Approve API Client for Actionable Requests</strong></br>
45
+ Users are required to log-in to eMASS and grant permissions for a client to update data
46
+ within eMASS on their behalf. This is only required for actionable requests (PUT, POST,
47
+ DELETE). The Registration Endpoint and all GET requests can be accessed without completing
48
+ this process with the correct permissions. Please note that leaving a field parameter blank
49
+ (for PUT/POST requests) has the potential to clear information in the active eMASS records.
50
+
51
+ To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC:
52
+
53
+
54
+ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
55
+
56
+ - API version: v3.3
57
+ - Package version: 1.0.6
58
+ - Build package: org.openapitools.codegen.languages.RubyClientCodegen
59
+ For more information, please visit [https://www.dcsa.mil/is/emass/](https://www.dcsa.mil/is/emass/)
900
60
 
901
- # Configure API key authorization: userid
902
- config.api_key['user-uid'] = 'YOUR API KEY'
903
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
904
- #config.api_key_prefix['user-uid'] = 'Bearer'
905
- end
61
+ ## Installation
906
62
 
907
- api_instance = EmassClient::SystemsApi.new
908
- opts = {
909
- include_package: true, # BOOLEAN | **Include Package**: Indicates if additional packages information is retrieved for queried system.
910
- registration_type: 'regular', # String | **Registration Type**: Filter record by selected registration type (single value or comma delimited values). *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider
911
- ditpr_id: 'ditpr_id_example', # String | **DITPR ID**: Filter query by DoD Information Technology (IT) Portfolio Repository (DITPR).
912
- coams_id: 'coams_id_example', # String | **COAMS ID**: Filter query by Cyber Operational Attributes Management System (COAMS).
913
- policy: 'rmf', # String | **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information.
914
- include_ditpr_metrics: false, # BOOLEAN | **Include DITPR**: Indicates if DITPR metrics are retrieved. This query string parameter can only be used in conjunction with the following parameters:<br> <ul> <li>registrationType</li> <li>policy</li> </ul>
915
- include_decommissioned: true, # BOOLEAN | **Include Decommissioned Systems**: Indicates if decommissioned systems are retrieved. If no value is specified, the default returns true to include decommissioned systems.
916
- reports_for_scorecard: true # BOOLEAN | **DoD Cyber Hygiene Scorecard**: Indicates if the system reports to the DoD Cyber Hygiene Scorecard.
917
- }
63
+ ### Build a gem
918
64
 
919
- begin
920
- #Get system information
921
- result = api_instance.get_systems(opts)
922
- p result
923
- rescue EmassClient::ApiError => e
924
- puts "Exception when calling SystemsApi->get_systems: #{e}"
925
- end
926
- # Setup authorization
927
- EmassClient.configure do |config|
928
- # Configure API key authorization: apikey
929
- config.api_key['api-key'] = 'YOUR API KEY'
930
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
931
- #config.api_key_prefix['api-key'] = 'Bearer'
65
+ To build the Ruby code into a gem:
932
66
 
933
- # Configure API key authorization: mockType
934
- config.api_key['Prefer'] = 'YOUR API KEY'
935
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
936
- #config.api_key_prefix['Prefer'] = 'Bearer'
67
+ ```shell
68
+ gem build emass_client.gemspec
69
+ ```
937
70
 
938
- # Configure API key authorization: userid
939
- config.api_key['user-uid'] = 'YOUR API KEY'
940
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
941
- #config.api_key_prefix['user-uid'] = 'Bearer'
942
- end
71
+ Then either install the gem locally:
943
72
 
944
- api_instance = EmassClient::TestApi.new
73
+ ```shell
74
+ gem install ./emass_client-1.0.6.gem
75
+ ```
945
76
 
946
- begin
947
- #Test connection to the API
948
- result = api_instance.test_connection
949
- p result
950
- rescue EmassClient::ApiError => e
951
- puts "Exception when calling TestApi->test_connection: #{e}"
952
- end
953
- # Setup authorization
954
- EmassClient.configure do |config|
955
- # Configure API key authorization: apikey
956
- config.api_key['api-key'] = 'YOUR API KEY'
957
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
958
- #config.api_key_prefix['api-key'] = 'Bearer'
77
+ (for development, run `gem install --dev ./emass_client-1.0.6.gem` to install the development dependencies)
959
78
 
960
- # Configure API key authorization: mockType
961
- config.api_key['Prefer'] = 'YOUR API KEY'
962
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
963
- #config.api_key_prefix['Prefer'] = 'Bearer'
79
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
964
80
 
965
- # Configure API key authorization: userid
966
- config.api_key['user-uid'] = 'YOUR API KEY'
967
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
968
- #config.api_key_prefix['user-uid'] = 'Bearer'
969
- end
81
+ Finally add this to the Gemfile:
970
82
 
971
- api_instance = EmassClient::TestResultsApi.new
972
- body = EmassClient::TestResultsRequestPostBody.new # TestResultsRequestPostBody | Update an existing control by Id
973
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
83
+ gem 'emass_client', '~> 1.0.6'
974
84
 
85
+ ### Install from Git
975
86
 
976
- begin
977
- #Add one or many test results in a system
978
- result = api_instance.add_test_results_by_system_id(body, system_id)
979
- p result
980
- rescue EmassClient::ApiError => e
981
- puts "Exception when calling TestResultsApi->add_test_results_by_system_id: #{e}"
982
- end
983
- # Setup authorization
984
- EmassClient.configure do |config|
985
- # Configure API key authorization: apikey
986
- config.api_key['api-key'] = 'YOUR API KEY'
987
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
988
- #config.api_key_prefix['api-key'] = 'Bearer'
87
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
989
88
 
990
- # Configure API key authorization: mockType
991
- config.api_key['Prefer'] = 'YOUR API KEY'
992
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
993
- #config.api_key_prefix['Prefer'] = 'Bearer'
89
+ gem 'emass_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
994
90
 
995
- # Configure API key authorization: userid
996
- config.api_key['user-uid'] = 'YOUR API KEY'
997
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
998
- #config.api_key_prefix['user-uid'] = 'Bearer'
999
- end
91
+ ### Include the Ruby code directly
1000
92
 
1001
- api_instance = EmassClient::TestResultsApi.new
1002
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
1003
- opts = {
1004
- control_acronyms: 'control_acronyms_example', # String | **System Acronym**: Filter query by given system acronym (single or comma separated).
1005
- ccis: 'ccis_example', # String | **CCI System**: Filter query by Control Correlation Identifiers (CCIs).
1006
- latest_only: true # BOOLEAN | **Latest Results Only**: Indicates that only the latest test resultes are retrieved (single or comma separated).
1007
- }
93
+ Include the Ruby code directly using `-I` as follows:
1008
94
 
1009
- begin
1010
- #Get one or many test results in a system
1011
- result = api_instance.get_system_test_results(system_id, opts)
1012
- p result
1013
- rescue EmassClient::ApiError => e
1014
- puts "Exception when calling TestResultsApi->get_system_test_results: #{e}"
1015
- end
1016
- # Setup authorization
1017
- EmassClient.configure do |config|
1018
- # Configure API key authorization: apikey
1019
- config.api_key['api-key'] = 'YOUR API KEY'
1020
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1021
- #config.api_key_prefix['api-key'] = 'Bearer'
95
+ ```shell
96
+ ruby -Ilib script.rb
97
+ ```
1022
98
 
1023
- # Configure API key authorization: mockType
1024
- config.api_key['Prefer'] = 'YOUR API KEY'
1025
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1026
- #config.api_key_prefix['Prefer'] = 'Bearer'
99
+ ## Getting Started
1027
100
 
1028
- # Configure API key authorization: userid
1029
- config.api_key['user-uid'] = 'YOUR API KEY'
1030
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1031
- #config.api_key_prefix['user-uid'] = 'Bearer'
1032
- end
101
+ Please follow the [installation](#installation) procedure and then run the following code:
1033
102
 
1034
- api_instance = EmassClient::WorkflowDefinitionsApi.new
1035
- opts = {
1036
- include_inactive: true, # BOOLEAN | **Include Inactive**: If no value is specified, the default returns false to not include outdated workflow definitions.
1037
- registration_type: 'regular' # String | **Registration Type**: Filter record by selected registration type (single value or comma delimited values). *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider
1038
- }
103
+ ```ruby
104
+ # Load the gem
105
+ require 'emass_client'
1039
106
 
1040
- begin
1041
- #Get workflow definitions in a site
1042
- result = api_instance.get_workflow_definitions(opts)
1043
- p result
1044
- rescue EmassClient::ApiError => e
1045
- puts "Exception when calling WorkflowDefinitionsApi->get_workflow_definitions: #{e}"
1046
- end
1047
107
  # Setup authorization
1048
108
  EmassClient.configure do |config|
1049
- # Configure API key authorization: apikey
1050
- config.api_key['api-key'] = 'YOUR API KEY'
109
+ # Configure API key authorization: apiKey
110
+ config.api_key['apiKey'] = 'YOUR API KEY'
1051
111
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1052
- #config.api_key_prefix['api-key'] = 'Bearer'
112
+ # config.api_key_prefix['apiKey'] = 'Bearer'
1053
113
 
1054
114
  # Configure API key authorization: mockType
1055
- config.api_key['Prefer'] = 'YOUR API KEY'
115
+ config.api_key['mockType'] = 'YOUR API KEY'
1056
116
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1057
- #config.api_key_prefix['Prefer'] = 'Bearer'
117
+ # config.api_key_prefix['mockType'] = 'Bearer'
1058
118
 
1059
- # Configure API key authorization: userid
1060
- config.api_key['user-uid'] = 'YOUR API KEY'
119
+ # Configure API key authorization: userId
120
+ config.api_key['userId'] = 'YOUR API KEY'
1061
121
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1062
- #config.api_key_prefix['user-uid'] = 'Bearer'
122
+ # config.api_key_prefix['userId'] = 'Bearer'
1063
123
  end
1064
124
 
1065
- api_instance = EmassClient::WorkflowInstancesApi.new
1066
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
1067
- opts = {
1068
- include_comments: true, # BOOLEAN | **Include Comments**: If no value is specified, the default returns true to not include transition comments. Note: Corresponds to the Comments textbox that is required at most workflow transitions. Does not include other text input fields such as Terms / Conditions for Authorization.
1069
- page_index: 0, # Integer | **Page Index**: If no value is specified, the default returns true to not include transition comments.
1070
- since_date: 'since_date_example', # String | **Date**: Filter on authorization/assessment date (Unix date format). Note: Filters off the lastEditedDate field. Note: The authorization/assessment decisions on completed workflows can be edited for up to 30 days after the initial decision is made.
1071
- status: 'all' # String | **Status**: Filter by status. If no value is specified, the default returns all to include both active and inactive workflows. Note: Any workflows at a current stage of Complete or Cancelled are inactive. Ongoing workflows currently at other stages are active.
125
+ api_instance = EmassClient::ArtifactsApi.new
126
+ system_id = 35 # Integer | **System Id**: The unique system record identifier.
127
+ zipper = File.new('/path/to/some/file') # File |
128
+ opts = {
129
+ is_template: true, # Boolean |
130
+ type: 'Procedure', # String |
131
+ category: 'Implementation Guidance' # String |
1072
132
  }
1073
133
 
1074
134
  begin
1075
- #Get workflow instances in a system
1076
- result = api_instance.get_system_workflow_instances(system_id, opts)
135
+ #Add one or many artifacts in a system
136
+ result = api_instance.add_artifacts_by_system_id(system_id, zipper, opts)
1077
137
  p result
1078
138
  rescue EmassClient::ApiError => e
1079
- puts "Exception when calling WorkflowInstancesApi->get_system_workflow_instances: #{e}"
1080
- end
1081
- # Setup authorization
1082
- EmassClient.configure do |config|
1083
- # Configure API key authorization: apikey
1084
- config.api_key['api-key'] = 'YOUR API KEY'
1085
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1086
- #config.api_key_prefix['api-key'] = 'Bearer'
1087
-
1088
- # Configure API key authorization: mockType
1089
- config.api_key['Prefer'] = 'YOUR API KEY'
1090
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1091
- #config.api_key_prefix['Prefer'] = 'Bearer'
1092
-
1093
- # Configure API key authorization: userid
1094
- config.api_key['user-uid'] = 'YOUR API KEY'
1095
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1096
- #config.api_key_prefix['user-uid'] = 'Bearer'
139
+ puts "Exception when calling ArtifactsApi->add_artifacts_by_system_id: #{e}"
1097
140
  end
1098
141
 
1099
- api_instance = EmassClient::WorkflowInstancesApi.new
1100
- system_id = 56 # Integer | **System Id**: The unique system record identifier.
1101
- workflow_instance_id = 56 # Integer | **Workflow Instance Id**: The unique milestone record identifier.
1102
-
1103
-
1104
- begin
1105
- #Get workflow instance by ID in a system
1106
- result = api_instance.get_system_workflow_instances_by_workflow_instance_id(system_id, workflow_instance_id)
1107
- p result
1108
- rescue EmassClient::ApiError => e
1109
- puts "Exception when calling WorkflowInstancesApi->get_system_workflow_instances_by_workflow_instance_id: #{e}"
1110
- end
1111
142
  ```
1112
143
 
1113
144
  ## Documentation for API Endpoints
@@ -1124,6 +155,8 @@ Class | Method | HTTP request | Description
1124
155
  *EmassClient::CACApi* | [**add_system_cac**](docs/CACApi.md#add_system_cac) | **POST** /api/systems/{systemId}/approval/cac | Submit control to second role of CAC
1125
156
  *EmassClient::CACApi* | [**get_system_cac**](docs/CACApi.md#get_system_cac) | **GET** /api/systems/{systemId}/approval/cac | Get location of one or many controls in CAC
1126
157
  *EmassClient::CMMCAssessmentsApi* | [**get_cmmc_assessments**](docs/CMMCAssessmentsApi.md#get_cmmc_assessments) | **GET** /api/cmmc-assessments | Get CMMC assessment information
158
+ *EmassClient::CloudResourcesApi* | [**add_cloud_resources_by_system_id**](docs/CloudResourcesApi.md#add_cloud_resources_by_system_id) | **POST** /api/systems/{systemId}/cloud-resource-results | Add one or many cloud resources and their scan results
159
+ *EmassClient::ContainersApi* | [**add_container_sans_by_system_id**](docs/ContainersApi.md#add_container_sans_by_system_id) | **POST** /api/systems/{systemId}/container-scan-results | Add one or many containers and their scan results
1127
160
  *EmassClient::ControlsApi* | [**get_system_controls**](docs/ControlsApi.md#get_system_controls) | **GET** /api/systems/{systemId}/controls | Get control information in a system for one or many controls
1128
161
  *EmassClient::ControlsApi* | [**update_control_by_system_id**](docs/ControlsApi.md#update_control_by_system_id) | **PUT** /api/systems/{systemId}/controls | Update control information in a system for one or many controls
1129
162
  *EmassClient::MilestonesApi* | [**add_milestone_by_system_id_and_poam_id**](docs/MilestonesApi.md#add_milestone_by_system_id_and_poam_id) | **POST** /api/systems/{systemId}/poams/{poamId}/milestones | Add milestones to one or many POA&M items in a system
@@ -1147,124 +180,117 @@ Class | Method | HTTP request | Description
1147
180
  *EmassClient::TestApi* | [**test_connection**](docs/TestApi.md#test_connection) | **GET** /api | Test connection to the API
1148
181
  *EmassClient::TestResultsApi* | [**add_test_results_by_system_id**](docs/TestResultsApi.md#add_test_results_by_system_id) | **POST** /api/systems/{systemId}/test-results | Add one or many test results in a system
1149
182
  *EmassClient::TestResultsApi* | [**get_system_test_results**](docs/TestResultsApi.md#get_system_test_results) | **GET** /api/systems/{systemId}/test-results | Get one or many test results in a system
1150
- *EmassClient::WorkflowDefinitionsApi* | [**get_workflow_definitions**](docs/WorkflowDefinitionsApi.md#get_workflow_definitions) | **GET** /api/workflow-definitions | Get workflow definitions in a site
1151
- *EmassClient::WorkflowInstancesApi* | [**get_system_workflow_instances**](docs/WorkflowInstancesApi.md#get_system_workflow_instances) | **GET** /api/systems/{systemId}/workflow-instances | Get workflow instances in a system
1152
- *EmassClient::WorkflowInstancesApi* | [**get_system_workflow_instances_by_workflow_instance_id**](docs/WorkflowInstancesApi.md#get_system_workflow_instances_by_workflow_instance_id) | **GET** /api/systems/{systemId}/workflow-instances/{workflowInstanceId} | Get workflow instance by ID in a system
183
+ *EmassClient::WorkflowDefinitionsApi* | [**get_workflow_definitions**](docs/WorkflowDefinitionsApi.md#get_workflow_definitions) | **GET** /api/workflows/definitions | Get workflow definitions in a site
184
+ *EmassClient::WorkflowInstancesApi* | [**get_system_workflow_instances**](docs/WorkflowInstancesApi.md#get_system_workflow_instances) | **GET** /api/workflows/instances | Get workflow instances in a site
185
+ *EmassClient::WorkflowInstancesApi* | [**get_system_workflow_instances_by_workflow_instance_id**](docs/WorkflowInstancesApi.md#get_system_workflow_instances_by_workflow_instance_id) | **GET** /api/workflows/instances/{workflowInstanceId} | Get workflow instance by ID
186
+
1153
187
 
1154
188
  ## Documentation for Models
1155
189
 
1156
- - [EmassClient::ArtifactsDelete](docs/ArtifactsDelete.md)
1157
- - [EmassClient::ArtifactsDeleteInner](docs/ArtifactsDeleteInner.md)
1158
190
  - [EmassClient::ArtifactsGet](docs/ArtifactsGet.md)
1159
- - [EmassClient::ArtifactsRequestPutBody](docs/ArtifactsRequestPutBody.md)
191
+ - [EmassClient::ArtifactsRequestDeleteBodyInner](docs/ArtifactsRequestDeleteBodyInner.md)
1160
192
  - [EmassClient::ArtifactsResponseDel](docs/ArtifactsResponseDel.md)
1161
- - [EmassClient::ArtifactsResponseDelData](docs/ArtifactsResponseDelData.md)
193
+ - [EmassClient::ArtifactsResponseDelDataInner](docs/ArtifactsResponseDelDataInner.md)
1162
194
  - [EmassClient::ArtifactsResponseGet](docs/ArtifactsResponseGet.md)
1163
195
  - [EmassClient::ArtifactsResponsePutPost](docs/ArtifactsResponsePutPost.md)
196
+ - [EmassClient::ArtifactsResponsePutPostDataInner](docs/ArtifactsResponsePutPostDataInner.md)
1164
197
  - [EmassClient::CacGet](docs/CacGet.md)
1165
- - [EmassClient::CacRequestPostBody](docs/CacRequestPostBody.md)
1166
198
  - [EmassClient::CacResponseGet](docs/CacResponseGet.md)
1167
199
  - [EmassClient::CacResponsePost](docs/CacResponsePost.md)
1168
- - [EmassClient::CacResponsePostData](docs/CacResponsePostData.md)
200
+ - [EmassClient::CacResponsePostDataInner](docs/CacResponsePostDataInner.md)
201
+ - [EmassClient::CloudResourcesPost](docs/CloudResourcesPost.md)
202
+ - [EmassClient::CloudResourcesResponsePost](docs/CloudResourcesResponsePost.md)
1169
203
  - [EmassClient::CmmcGet](docs/CmmcGet.md)
1170
204
  - [EmassClient::CmmcResponseGet](docs/CmmcResponseGet.md)
1171
205
  - [EmassClient::ConnectivityCcsd](docs/ConnectivityCcsd.md)
206
+ - [EmassClient::ContainersResourcesPost](docs/ContainersResourcesPost.md)
207
+ - [EmassClient::ContainersResponsePost](docs/ContainersResponsePost.md)
1172
208
  - [EmassClient::ControlsGet](docs/ControlsGet.md)
1173
209
  - [EmassClient::ControlsPut](docs/ControlsPut.md)
1174
- - [EmassClient::ControlsRequestPutBody](docs/ControlsRequestPutBody.md)
1175
210
  - [EmassClient::ControlsResponseGet](docs/ControlsResponseGet.md)
1176
211
  - [EmassClient::ControlsResponsePut](docs/ControlsResponsePut.md)
1177
212
  - [EmassClient::DefinitionTransitions](docs/DefinitionTransitions.md)
1178
- - [EmassClient::DeleteMilestone](docs/DeleteMilestone.md)
1179
- - [EmassClient::DeletePoam](docs/DeletePoam.md)
1180
- - [EmassClient::Empty200Response](docs/Empty200Response.md)
1181
- - [EmassClient::Error](docs/Error.md)
1182
213
  - [EmassClient::InstancesTransitions](docs/InstancesTransitions.md)
1183
214
  - [EmassClient::MilestoneResponseGet](docs/MilestoneResponseGet.md)
215
+ - [EmassClient::MilestoneResponseGetMilestone](docs/MilestoneResponseGetMilestone.md)
1184
216
  - [EmassClient::MilestoneResponsePost](docs/MilestoneResponsePost.md)
1185
217
  - [EmassClient::MilestoneResponsePut](docs/MilestoneResponsePut.md)
1186
- - [EmassClient::MilestonesDelete](docs/MilestonesDelete.md)
1187
218
  - [EmassClient::MilestonesGet](docs/MilestonesGet.md)
1188
- - [EmassClient::MilestonesPost](docs/MilestonesPost.md)
1189
- - [EmassClient::MilestonesPut](docs/MilestonesPut.md)
1190
219
  - [EmassClient::MilestonesPutPostDelete](docs/MilestonesPutPostDelete.md)
1191
- - [EmassClient::MilestonesRequestPostBody](docs/MilestonesRequestPostBody.md)
1192
- - [EmassClient::MilestonesRequestPutBody](docs/MilestonesRequestPutBody.md)
220
+ - [EmassClient::MilestonesRequestDeleteBodyInner](docs/MilestonesRequestDeleteBodyInner.md)
1193
221
  - [EmassClient::MilestonesRequiredPost](docs/MilestonesRequiredPost.md)
1194
222
  - [EmassClient::MilestonesRequiredPut](docs/MilestonesRequiredPut.md)
1195
- - [EmassClient::Model200](docs/Model200.md)
1196
- - [EmassClient::Model201](docs/Model201.md)
1197
- - [EmassClient::Model201Meta](docs/Model201Meta.md)
1198
- - [EmassClient::Model400](docs/Model400.md)
1199
- - [EmassClient::Model400Meta](docs/Model400Meta.md)
1200
- - [EmassClient::Model400Response](docs/Model400Response.md)
1201
- - [EmassClient::Model401](docs/Model401.md)
1202
- - [EmassClient::Model401Meta](docs/Model401Meta.md)
1203
- - [EmassClient::Model403](docs/Model403.md)
1204
- - [EmassClient::Model403Meta](docs/Model403Meta.md)
1205
- - [EmassClient::Model404](docs/Model404.md)
1206
- - [EmassClient::Model404Response](docs/Model404Response.md)
1207
- - [EmassClient::Model405](docs/Model405.md)
1208
- - [EmassClient::Model405Meta](docs/Model405Meta.md)
1209
- - [EmassClient::Model411](docs/Model411.md)
1210
- - [EmassClient::Model411Meta](docs/Model411Meta.md)
1211
- - [EmassClient::Model490](docs/Model490.md)
1212
- - [EmassClient::Model490Meta](docs/Model490Meta.md)
1213
- - [EmassClient::Model500](docs/Model500.md)
1214
- - [EmassClient::Model500Meta](docs/Model500Meta.md)
1215
223
  - [EmassClient::PacGet](docs/PacGet.md)
1216
224
  - [EmassClient::PacPost](docs/PacPost.md)
1217
- - [EmassClient::PacRequestPostBody](docs/PacRequestPostBody.md)
1218
225
  - [EmassClient::PacResponseGet](docs/PacResponseGet.md)
1219
226
  - [EmassClient::PacResponsePost](docs/PacResponsePost.md)
1220
- - [EmassClient::PoamDelete](docs/PoamDelete.md)
1221
227
  - [EmassClient::PoamGet](docs/PoamGet.md)
1222
- - [EmassClient::PoamPost](docs/PoamPost.md)
1223
228
  - [EmassClient::PoamPostPutDel](docs/PoamPostPutDel.md)
1224
- - [EmassClient::PoamPut](docs/PoamPut.md)
1225
- - [EmassClient::PoamRequestPostBody](docs/PoamRequestPostBody.md)
1226
- - [EmassClient::PoamRequestPutBody](docs/PoamRequestPutBody.md)
1227
- - [EmassClient::PoamRequiredPost](docs/PoamRequiredPost.md)
1228
- - [EmassClient::PoamRequiredPut](docs/PoamRequiredPut.md)
229
+ - [EmassClient::PoamRequestDeleteBodyInner](docs/PoamRequestDeleteBodyInner.md)
1229
230
  - [EmassClient::PoamResponseDelete](docs/PoamResponseDelete.md)
1230
- - [EmassClient::PoamResponseGet](docs/PoamResponseGet.md)
231
+ - [EmassClient::PoamResponseGetPoams](docs/PoamResponseGetPoams.md)
232
+ - [EmassClient::PoamResponseGetSystems](docs/PoamResponseGetSystems.md)
1231
233
  - [EmassClient::PoamResponsePost](docs/PoamResponsePost.md)
1232
234
  - [EmassClient::PoamResponsePut](docs/PoamResponsePut.md)
1233
235
  - [EmassClient::Register](docs/Register.md)
1234
236
  - [EmassClient::RegisterData](docs/RegisterData.md)
1235
237
  - [EmassClient::RegisterUserRequestPostBody](docs/RegisterUserRequestPostBody.md)
238
+ - [EmassClient::Response200](docs/Response200.md)
239
+ - [EmassClient::Response201](docs/Response201.md)
240
+ - [EmassClient::Response201Meta](docs/Response201Meta.md)
241
+ - [EmassClient::Response400](docs/Response400.md)
242
+ - [EmassClient::Response400Meta](docs/Response400Meta.md)
243
+ - [EmassClient::Response401](docs/Response401.md)
244
+ - [EmassClient::Response401Meta](docs/Response401Meta.md)
245
+ - [EmassClient::Response403](docs/Response403.md)
246
+ - [EmassClient::Response403Meta](docs/Response403Meta.md)
247
+ - [EmassClient::Response404](docs/Response404.md)
248
+ - [EmassClient::Response405](docs/Response405.md)
249
+ - [EmassClient::Response405Meta](docs/Response405Meta.md)
250
+ - [EmassClient::Response411](docs/Response411.md)
251
+ - [EmassClient::Response411Meta](docs/Response411Meta.md)
252
+ - [EmassClient::Response490](docs/Response490.md)
253
+ - [EmassClient::Response490Meta](docs/Response490Meta.md)
254
+ - [EmassClient::Response500](docs/Response500.md)
255
+ - [EmassClient::Response500Meta](docs/Response500Meta.md)
1236
256
  - [EmassClient::RoleCategory](docs/RoleCategory.md)
1237
257
  - [EmassClient::Roles](docs/Roles.md)
1238
258
  - [EmassClient::Ssps](docs/Ssps.md)
1239
259
  - [EmassClient::Stage](docs/Stage.md)
1240
260
  - [EmassClient::StaticCodeApplication](docs/StaticCodeApplication.md)
261
+ - [EmassClient::StaticCodePost](docs/StaticCodePost.md)
1241
262
  - [EmassClient::StaticCodeRequestPostBody](docs/StaticCodeRequestPostBody.md)
1242
- - [EmassClient::StaticCodeRequiredPost](docs/StaticCodeRequiredPost.md)
1243
- - [EmassClient::StaticCodeRequiredPostApplication](docs/StaticCodeRequiredPostApplication.md)
263
+ - [EmassClient::StaticCodeRequestPostBodyApplication](docs/StaticCodeRequestPostBodyApplication.md)
264
+ - [EmassClient::StaticCodeResponsePost](docs/StaticCodeResponsePost.md)
1244
265
  - [EmassClient::Success200Response](docs/Success200Response.md)
1245
- - [EmassClient::SystemIdArtifactsBody](docs/SystemIdArtifactsBody.md)
266
+ - [EmassClient::Success200ResponseDataInner](docs/Success200ResponseDataInner.md)
1246
267
  - [EmassClient::SystemResponse](docs/SystemResponse.md)
1247
268
  - [EmassClient::SystemRolesCategoryResponse](docs/SystemRolesCategoryResponse.md)
1248
269
  - [EmassClient::SystemRolesResponse](docs/SystemRolesResponse.md)
1249
- - [EmassClient::SystemRolesResponseData](docs/SystemRolesResponseData.md)
270
+ - [EmassClient::SystemRolesResponseDataInner](docs/SystemRolesResponseDataInner.md)
1250
271
  - [EmassClient::Systems](docs/Systems.md)
272
+ - [EmassClient::SystemsResponse](docs/SystemsResponse.md)
1251
273
  - [EmassClient::Test](docs/Test.md)
1252
274
  - [EmassClient::TestData](docs/TestData.md)
1253
275
  - [EmassClient::TestResultsGet](docs/TestResultsGet.md)
1254
276
  - [EmassClient::TestResultsPost](docs/TestResultsPost.md)
1255
- - [EmassClient::TestResultsRequestPostBody](docs/TestResultsRequestPostBody.md)
1256
277
  - [EmassClient::TestResultsResponseGet](docs/TestResultsResponseGet.md)
1257
278
  - [EmassClient::TestResultsResponsePost](docs/TestResultsResponsePost.md)
1258
279
  - [EmassClient::Users](docs/Users.md)
1259
280
  - [EmassClient::WorkflowDefinitionGet](docs/WorkflowDefinitionGet.md)
1260
281
  - [EmassClient::WorkflowDefinitionResponseGet](docs/WorkflowDefinitionResponseGet.md)
282
+ - [EmassClient::WorkflowInstanceGet](docs/WorkflowInstanceGet.md)
283
+ - [EmassClient::WorkflowInstanceResponseGet](docs/WorkflowInstanceResponseGet.md)
1261
284
  - [EmassClient::WorkflowInstancesGet](docs/WorkflowInstancesGet.md)
1262
285
  - [EmassClient::WorkflowInstancesResponseGet](docs/WorkflowInstancesResponseGet.md)
286
+ - [EmassClient::WorkflowInstancesResponseGetPagination](docs/WorkflowInstancesResponseGetPagination.md)
287
+
1263
288
 
1264
289
  ## Documentation for Authorization
1265
290
 
1266
291
 
1267
- ### apikey
292
+ ### apiKey
293
+
1268
294
 
1269
295
  - **Type**: API key
1270
296
  - **API key parameter name**: api-key
@@ -1272,11 +298,13 @@ Class | Method | HTTP request | Description
1272
298
 
1273
299
  ### mockType
1274
300
 
301
+
1275
302
  - **Type**: API key
1276
303
  - **API key parameter name**: Prefer
1277
304
  - **Location**: HTTP header
1278
305
 
1279
- ### userid
306
+ ### userId
307
+
1280
308
 
1281
309
  - **Type**: API key
1282
310
  - **API key parameter name**: user-uid