emass_client 3.10.1 → 3.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +57 -44
- data/lib/emass_client/api/artifacts_api.rb +14 -11
- data/lib/emass_client/api/artifacts_export_api.rb +3 -3
- data/lib/emass_client/api/cac_api.rb +7 -7
- data/lib/emass_client/api/cloud_resource_results_api.rb +79 -5
- data/lib/emass_client/api/cmmc_assessments_api.rb +3 -3
- data/lib/emass_client/api/container_scan_results_api.rb +79 -5
- data/lib/emass_client/api/controls_api.rb +5 -5
- data/lib/emass_client/api/enterprise_artifacts_dashboards_api.rb +168 -0
- data/lib/emass_client/api/enterprise_poam_dashboards_api.rb +168 -0
- data/lib/emass_client/api/enterprise_security_controls_dashboards_api.rb +241 -0
- data/lib/emass_client/api/enterprise_sensor_based_hardware_resources_dashboards_api.rb +168 -0
- data/lib/emass_client/api/enterprise_sensor_based_software_resources_dashboards_api.rb +241 -0
- data/lib/emass_client/api/enterprise_terms_conditions_dashboards_api.rb +168 -0
- data/lib/emass_client/api/enterprise_vulnerability_dashboards_api.rb +241 -0
- data/lib/emass_client/api/fisma_inventory_summary_dashboards_api.rb +168 -0
- data/lib/emass_client/api/hardware_baseline_dashboards_api.rb +168 -0
- data/lib/emass_client/api/milestones_api.rb +6 -6
- data/lib/emass_client/api/pac_api.rb +11 -11
- data/lib/emass_client/api/poam_api.rb +12 -9
- data/lib/emass_client/api/ports_and_protocols_dashboards_api.rb +168 -0
- data/lib/emass_client/api/privacy_compliance_dashboards_api.rb +168 -0
- data/lib/emass_client/api/registration_api.rb +3 -3
- data/lib/emass_client/api/software_baseline_dashboards_api.rb +168 -0
- data/lib/emass_client/api/static_code_scans_api.rb +5 -5
- data/lib/emass_client/api/system_a20_summary_dashboard_api.rb +95 -0
- data/lib/emass_client/api/system_aa_summary_dashboard_api.rb +95 -0
- data/lib/emass_client/api/system_associations_dashboard_api.rb +95 -0
- data/lib/emass_client/api/system_conmon_integration_status_dashboard_api.rb +95 -0
- data/lib/emass_client/api/system_pl109_reporting_summary_dashboard_api.rb +95 -0
- data/lib/emass_client/api/system_roles_api.rb +5 -13
- data/lib/emass_client/api/system_status_dashboard_api.rb +95 -0
- data/lib/emass_client/api/systems_api.rb +26 -26
- data/lib/emass_client/api/test_api.rb +3 -3
- data/lib/emass_client/api/test_results_api.rb +14 -11
- data/lib/emass_client/api/threat_risks_dashboards_api.rb +241 -0
- data/lib/emass_client/api/users_dashboard_api.rb +95 -0
- data/lib/emass_client/api/workflow_definitions_api.rb +3 -3
- data/lib/emass_client/api/workflow_instances_api.rb +6 -3
- data/lib/emass_client/api_client.rb +5 -4
- data/lib/emass_client/api_error.rb +3 -3
- data/lib/emass_client/configuration.rb +3 -3
- data/lib/emass_client/models/artifacts_get.rb +28 -23
- data/lib/emass_client/models/artifacts_request_delete_body_inner.rb +15 -20
- data/lib/emass_client/models/artifacts_response_del.rb +15 -20
- data/lib/emass_client/models/artifacts_response_del_data_inner.rb +15 -20
- data/lib/emass_client/models/artifacts_response_get.rb +15 -20
- data/lib/emass_client/models/artifacts_response_put_post.rb +15 -20
- data/lib/emass_client/models/artifacts_response_put_post_data_inner.rb +29 -25
- data/lib/emass_client/models/cac_get.rb +15 -20
- data/lib/emass_client/models/cac_response_get.rb +15 -20
- data/lib/emass_client/models/cac_response_post.rb +15 -20
- data/lib/emass_client/models/cac_response_post_data_inner.rb +29 -25
- data/lib/emass_client/models/cloud_resources_delete.rb +225 -0
- data/lib/emass_client/models/cloud_resources_delete_body_inner.rb +215 -0
- data/lib/emass_client/models/{cloud_resources_post.rb → cloud_resources_post_delete.rb} +32 -28
- data/lib/emass_client/models/cloud_resources_response_post.rb +16 -21
- data/lib/emass_client/models/cmmc_get.rb +15 -20
- data/lib/emass_client/models/cmmc_response_get.rb +15 -20
- data/lib/emass_client/models/connectivity_ccsd.rb +15 -20
- data/lib/emass_client/models/container_resources_delete_body_inner.rb +215 -0
- data/lib/emass_client/models/{containers_resources_post.rb → containers_resources_post_delete.rb} +32 -28
- data/lib/emass_client/models/containers_response_delete.rb +225 -0
- data/lib/emass_client/models/containers_response_post.rb +16 -21
- data/lib/emass_client/models/controls_get.rb +66 -39
- data/lib/emass_client/models/controls_put.rb +29 -25
- data/lib/emass_client/models/controls_response_get.rb +15 -20
- data/lib/emass_client/models/controls_response_put.rb +15 -20
- data/lib/emass_client/models/dashboard_mock_response.rb +15 -20
- data/lib/emass_client/models/dashboard_mock_response_pagination.rb +15 -20
- data/lib/emass_client/models/definition_transitions.rb +15 -20
- data/lib/emass_client/models/instances_transitions.rb +15 -20
- data/lib/emass_client/models/milestone_response_delete.rb +225 -0
- data/lib/emass_client/models/milestone_response_get.rb +15 -20
- data/lib/emass_client/models/milestone_response_get_milestone.rb +15 -20
- data/lib/emass_client/models/milestone_response_post.rb +15 -20
- data/lib/emass_client/models/milestone_response_put.rb +15 -20
- data/lib/emass_client/models/milestones_get.rb +15 -20
- data/lib/emass_client/models/milestones_put_post_delete.rb +29 -25
- data/lib/emass_client/models/milestones_request_delete_body_inner.rb +15 -20
- data/lib/emass_client/models/milestones_required_post.rb +19 -20
- data/lib/emass_client/models/milestones_required_put.rb +21 -20
- data/lib/emass_client/models/mock_object.rb +15 -20
- data/lib/emass_client/models/pac_get.rb +20 -45
- data/lib/emass_client/models/pac_post.rb +29 -25
- data/lib/emass_client/models/pac_response_get.rb +15 -20
- data/lib/emass_client/models/pac_response_post.rb +15 -20
- data/lib/emass_client/models/poam_get.rb +217 -36
- data/lib/emass_client/models/poam_post_put_del.rb +29 -25
- data/lib/emass_client/models/poam_request_delete_body_inner.rb +15 -20
- data/lib/emass_client/models/poam_response_delete.rb +15 -20
- data/lib/emass_client/models/poam_response_get_poams.rb +15 -20
- data/lib/emass_client/models/poam_response_get_systems.rb +15 -20
- data/lib/emass_client/models/poam_response_post.rb +15 -20
- data/lib/emass_client/models/poam_response_put.rb +15 -20
- data/lib/emass_client/models/register.rb +15 -20
- data/lib/emass_client/models/register_data.rb +15 -20
- data/lib/emass_client/models/register_user_request_post_body.rb +17 -20
- data/lib/emass_client/models/response200.rb +21 -22
- data/lib/emass_client/models/response201.rb +15 -20
- data/lib/emass_client/models/response201_meta.rb +21 -22
- data/lib/emass_client/models/response400.rb +15 -20
- data/lib/emass_client/models/response400_meta.rb +21 -22
- data/lib/emass_client/models/response401.rb +15 -20
- data/lib/emass_client/models/response401_meta.rb +21 -22
- data/lib/emass_client/models/response403.rb +15 -20
- data/lib/emass_client/models/response403_meta.rb +21 -22
- data/lib/emass_client/models/response404.rb +21 -22
- data/lib/emass_client/models/response405.rb +15 -20
- data/lib/emass_client/models/response405_meta.rb +21 -22
- data/lib/emass_client/models/response411.rb +15 -20
- data/lib/emass_client/models/response411_meta.rb +21 -22
- data/lib/emass_client/models/response490.rb +15 -20
- data/lib/emass_client/models/response490_meta.rb +21 -22
- data/lib/emass_client/models/response500.rb +15 -20
- data/lib/emass_client/models/response500_meta.rb +21 -22
- data/lib/emass_client/models/role_category.rb +15 -20
- data/lib/emass_client/models/roles.rb +15 -20
- data/lib/emass_client/models/ssps.rb +15 -20
- data/lib/emass_client/models/stage.rb +15 -20
- data/lib/emass_client/models/{static_code_application.rb → static_code_application_post.rb} +18 -23
- data/lib/emass_client/models/static_code_post.rb +29 -25
- data/lib/emass_client/models/static_code_request_post_body.rb +16 -21
- data/lib/emass_client/models/static_code_request_post_body_application.rb +15 -20
- data/lib/emass_client/models/static_code_response_post.rb +15 -20
- data/lib/emass_client/models/success200_response.rb +15 -20
- data/lib/emass_client/models/success200_response_data_inner.rb +29 -25
- data/lib/emass_client/models/system_response.rb +15 -20
- data/lib/emass_client/models/system_roles_category_response.rb +15 -20
- data/lib/emass_client/models/system_roles_response.rb +15 -20
- data/lib/emass_client/models/system_roles_response_data_inner.rb +15 -20
- data/lib/emass_client/models/systems.rb +248 -33
- data/lib/emass_client/models/systems_response.rb +15 -20
- data/lib/emass_client/models/test.rb +15 -20
- data/lib/emass_client/models/test_data.rb +15 -20
- data/lib/emass_client/models/test_results_get.rb +26 -21
- data/lib/emass_client/models/test_results_post.rb +29 -25
- data/lib/emass_client/models/test_results_response_get.rb +15 -20
- data/lib/emass_client/models/test_results_response_post.rb +15 -20
- data/lib/emass_client/models/users.rb +15 -20
- data/lib/emass_client/models/workflow_definition_get.rb +15 -20
- data/lib/emass_client/models/workflow_definition_response_get.rb +15 -20
- data/lib/emass_client/models/workflow_instance_get.rb +15 -20
- data/lib/emass_client/models/workflow_instance_response_get.rb +15 -20
- data/lib/emass_client/models/workflow_instances_get.rb +15 -20
- data/lib/emass_client/models/workflow_instances_response_get.rb +15 -20
- data/lib/emass_client/models/workflow_instances_response_get_pagination.rb +15 -20
- data/lib/emass_client/version.rb +4 -4
- data/lib/emass_client.rb +31 -7
- metadata +30 -6
- data/lib/emass_client/api/dashboards_api.rb +0 -2139
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 87dcd4dfbed9bb49fac63caec62143dd36315dee13f8c9d7c51d4c3a9b3b1cb6
|
|
4
|
+
data.tar.gz: 44b1225adcbf8b41714146774048f88f98831a1afc05d4297d61ae651445c854
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 84ed160e37e8f34920648bb8da5bed07b82ad2f625b90d0e9d32e4e4c541f1996d11fe70248118a94a525e2db718e83836c03ca86d6a6b8e46dc2f02f98a0b41
|
|
7
|
+
data.tar.gz: 5da138e153bec30d4dea39a5656b1125897702a44ccdfaf9d1b1f0b61887c36d3448135b30bf154fd2484ca564c4926c0fe9d0a1a6bb16d4b1e61c7d2c31b625
|
data/README.md
CHANGED
|
@@ -9,14 +9,12 @@ assessments and complete actions associated with system records.
|
|
|
9
9
|
<strong>Register External Application (that use the eMASS API)</strong></br>
|
|
10
10
|
New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf)
|
|
11
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
|
|
12
|
+
requires a client certificate (SSL/TLS, DoD PKI only). Use the `Registration` POST endpoint to register the client
|
|
13
|
+
certificate. The endpoint call returns the user `api-key`.</br></br>
|
|
14
14
|
|
|
15
15
|
Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key.
|
|
16
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
|
|
18
|
-
|
|
19
|
-
</br></br>
|
|
17
|
+
an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br>
|
|
20
18
|
|
|
21
19
|
<strong>Available Request Headers</strong></br>
|
|
22
20
|
<table>
|
|
@@ -55,8 +53,8 @@ To establish an account with eMASS and/or acquire an api-key/user-uid, contact o
|
|
|
55
53
|
|
|
56
54
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
57
55
|
|
|
58
|
-
- API version: v3.
|
|
59
|
-
- Package version: 3.
|
|
56
|
+
- API version: v3.12
|
|
57
|
+
- Package version: 3.12.0
|
|
60
58
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
61
59
|
For more information, please visit [https://www.dcsa.mil/is/emass/](https://www.dcsa.mil/is/emass/)
|
|
62
60
|
|
|
@@ -73,16 +71,16 @@ gem build emass_client.gemspec
|
|
|
73
71
|
Then either install the gem locally:
|
|
74
72
|
|
|
75
73
|
```shell
|
|
76
|
-
gem install ./emass_client-3.
|
|
74
|
+
gem install ./emass_client-3.12.0.gem
|
|
77
75
|
```
|
|
78
76
|
|
|
79
|
-
(for development, run `gem install --dev ./emass_client-3.
|
|
77
|
+
(for development, run `gem install --dev ./emass_client-3.12.0.gem` to install the development dependencies)
|
|
80
78
|
|
|
81
79
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
82
80
|
|
|
83
81
|
Finally add this to the Gemfile:
|
|
84
82
|
|
|
85
|
-
gem 'emass_client', '~> 3.
|
|
83
|
+
gem 'emass_client', '~> 3.12.0'
|
|
86
84
|
|
|
87
85
|
### Install from Git
|
|
88
86
|
|
|
@@ -159,59 +157,69 @@ Class | Method | HTTP request | Description
|
|
|
159
157
|
*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
|
|
160
158
|
*EmassClient::CMMCAssessmentsApi* | [**get_cmmc_assessments**](docs/CMMCAssessmentsApi.md#get_cmmc_assessments) | **GET** /api/cmmc-assessments | Get CMMC assessment information
|
|
161
159
|
*EmassClient::CloudResourceResultsApi* | [**add_cloud_resources_by_system_id**](docs/CloudResourceResultsApi.md#add_cloud_resources_by_system_id) | **POST** /api/systems/{systemId}/cloud-resource-results | Add one or many cloud resources and their scan results
|
|
160
|
+
*EmassClient::CloudResourceResultsApi* | [**delete_cloud_resources**](docs/CloudResourceResultsApi.md#delete_cloud_resources) | **DELETE** /api/systems/{systemId}/cloud-resource-results | Remove one or many cloud resources in a system
|
|
162
161
|
*EmassClient::ContainerScanResultsApi* | [**add_container_sans_by_system_id**](docs/ContainerScanResultsApi.md#add_container_sans_by_system_id) | **POST** /api/systems/{systemId}/container-scan-results | Add one or many containers and their scan results
|
|
162
|
+
*EmassClient::ContainerScanResultsApi* | [**delete_container_sans**](docs/ContainerScanResultsApi.md#delete_container_sans) | **DELETE** /api/systems/{systemId}/container-scan-results | Remove one or many containers in a system
|
|
163
163
|
*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
|
|
164
164
|
*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
|
|
165
|
-
*EmassClient::
|
|
166
|
-
*EmassClient::
|
|
167
|
-
*EmassClient::
|
|
168
|
-
*EmassClient::
|
|
169
|
-
*EmassClient::
|
|
170
|
-
*EmassClient::
|
|
171
|
-
*EmassClient::
|
|
172
|
-
*EmassClient::
|
|
173
|
-
*EmassClient::
|
|
174
|
-
*EmassClient::
|
|
175
|
-
*EmassClient::
|
|
176
|
-
*EmassClient::
|
|
177
|
-
*EmassClient::
|
|
178
|
-
*EmassClient::
|
|
179
|
-
*EmassClient::
|
|
180
|
-
*EmassClient::
|
|
181
|
-
*EmassClient::
|
|
182
|
-
*EmassClient::
|
|
183
|
-
*EmassClient::
|
|
184
|
-
*EmassClient::
|
|
185
|
-
*EmassClient::
|
|
186
|
-
*EmassClient::DashboardsApi* | [**get_va_system_a2_summary**](docs/DashboardsApi.md#get_va_system_a2_summary) | **GET** /api/dashboards/va-system-a2-summary | VA System A2.0 Summary
|
|
187
|
-
*EmassClient::DashboardsApi* | [**get_va_system_aa_summary**](docs/DashboardsApi.md#get_va_system_aa_summary) | **GET** /api/dashboards/va-system-aa-summary | VA System A&A Summary
|
|
188
|
-
*EmassClient::DashboardsApi* | [**get_va_system_fisma_invetory_crypto_summary**](docs/DashboardsApi.md#get_va_system_fisma_invetory_crypto_summary) | **GET** /api/dashboards/va-system-fisma-inventory-crypto-summary | VA System FISMA Inventory Crypto Summary
|
|
189
|
-
*EmassClient::DashboardsApi* | [**get_va_system_fisma_invetory_summary**](docs/DashboardsApi.md#get_va_system_fisma_invetory_summary) | **GET** /api/dashboards/va-system-fisma-inventory-summary | VA System FISMA Inventory Summary
|
|
190
|
-
*EmassClient::DashboardsApi* | [**get_va_system_pl109_reporting_summary**](docs/DashboardsApi.md#get_va_system_pl109_reporting_summary) | **GET** /api/dashboards/va-system-pl-109-reporting-summary | VA System P.L. 109 Reporting Summary
|
|
191
|
-
*EmassClient::DashboardsApi* | [**get_va_system_threat_architecture_details**](docs/DashboardsApi.md#get_va_system_threat_architecture_details) | **GET** /api/dashboards/va-system-threat-architecture-details | VA System Threat Architecture Details
|
|
192
|
-
*EmassClient::DashboardsApi* | [**get_va_system_threat_risk_summary**](docs/DashboardsApi.md#get_va_system_threat_risk_summary) | **GET** /api/dashboards/va-system-threat-risks-summary | VA System Threat Risks Summary
|
|
193
|
-
*EmassClient::DashboardsApi* | [**get_va_system_threat_source_details**](docs/DashboardsApi.md#get_va_system_threat_source_details) | **GET** /api/dashboards/va-system-threat-sources-details | VA System Threat Sources Details
|
|
165
|
+
*EmassClient::EnterpriseArtifactsDashboardsApi* | [**get_system_artifacts_details**](docs/EnterpriseArtifactsDashboardsApi.md#get_system_artifacts_details) | **GET** /api/dashboards/system-artifacts-details | System Artifacts Details
|
|
166
|
+
*EmassClient::EnterpriseArtifactsDashboardsApi* | [**get_system_artifacts_summary**](docs/EnterpriseArtifactsDashboardsApi.md#get_system_artifacts_summary) | **GET** /api/dashboards/system-artifacts-summary | System Artifacts Summary
|
|
167
|
+
*EmassClient::EnterprisePOAMDashboardsApi* | [**get_system_poam_details**](docs/EnterprisePOAMDashboardsApi.md#get_system_poam_details) | **GET** /api/dashboards/system-poam-details | System POA&M Details
|
|
168
|
+
*EmassClient::EnterprisePOAMDashboardsApi* | [**get_system_poam_summary**](docs/EnterprisePOAMDashboardsApi.md#get_system_poam_summary) | **GET** /api/dashboards/system-poam-summary | System POA&M Summary
|
|
169
|
+
*EmassClient::EnterpriseSecurityControlsDashboardsApi* | [**get_system_assessment_procedures_details**](docs/EnterpriseSecurityControlsDashboardsApi.md#get_system_assessment_procedures_details) | **GET** /api/dashboards/system-assessment-procedures-details | System Assessment Procedures Details
|
|
170
|
+
*EmassClient::EnterpriseSecurityControlsDashboardsApi* | [**get_system_control_compliance_summary**](docs/EnterpriseSecurityControlsDashboardsApi.md#get_system_control_compliance_summary) | **GET** /api/dashboards/system-control-compliance-summary | System Control Compliance Summary
|
|
171
|
+
*EmassClient::EnterpriseSecurityControlsDashboardsApi* | [**get_system_security_control_details**](docs/EnterpriseSecurityControlsDashboardsApi.md#get_system_security_control_details) | **GET** /api/dashboards/system-security-controls-details | System Control Compliance Details
|
|
172
|
+
*EmassClient::EnterpriseSensorBasedHardwareResourcesDashboardsApi* | [**get_system_sensor_hardware_details**](docs/EnterpriseSensorBasedHardwareResourcesDashboardsApi.md#get_system_sensor_hardware_details) | **GET** /api/dashboards/system-sensor-hardware-details | System Sensor Hardware Details
|
|
173
|
+
*EmassClient::EnterpriseSensorBasedHardwareResourcesDashboardsApi* | [**get_system_sensor_hardware_summary**](docs/EnterpriseSensorBasedHardwareResourcesDashboardsApi.md#get_system_sensor_hardware_summary) | **GET** /api/dashboards/system-sensor-hardware-summary | System Sensor Hardware Summary
|
|
174
|
+
*EmassClient::EnterpriseSensorBasedSoftwareResourcesDashboardsApi* | [**get_system_sensor_software_counts**](docs/EnterpriseSensorBasedSoftwareResourcesDashboardsApi.md#get_system_sensor_software_counts) | **GET** /api/dashboards/system-sensor-software-counts | System Sensor Software Counts
|
|
175
|
+
*EmassClient::EnterpriseSensorBasedSoftwareResourcesDashboardsApi* | [**get_system_sensor_software_details**](docs/EnterpriseSensorBasedSoftwareResourcesDashboardsApi.md#get_system_sensor_software_details) | **GET** /api/dashboards/system-sensor-software-details | System Sensor Software Details
|
|
176
|
+
*EmassClient::EnterpriseSensorBasedSoftwareResourcesDashboardsApi* | [**get_system_sensor_software_summary**](docs/EnterpriseSensorBasedSoftwareResourcesDashboardsApi.md#get_system_sensor_software_summary) | **GET** /api/dashboards/system-sensor-software-summary | System Sensor Software Summary
|
|
177
|
+
*EmassClient::EnterpriseTermsConditionsDashboardsApi* | [**get_system_terms_conditions_details**](docs/EnterpriseTermsConditionsDashboardsApi.md#get_system_terms_conditions_details) | **GET** /api/dashboards/system-terms-conditions-details | System Terms Conditions Details
|
|
178
|
+
*EmassClient::EnterpriseTermsConditionsDashboardsApi* | [**get_system_terms_conditions_summary**](docs/EnterpriseTermsConditionsDashboardsApi.md#get_system_terms_conditions_summary) | **GET** /api/dashboards/system-terms-conditions-summary | System Terms Conditions Summary
|
|
179
|
+
*EmassClient::EnterpriseVulnerabilityDashboardsApi* | [**get_system_device_findings_details**](docs/EnterpriseVulnerabilityDashboardsApi.md#get_system_device_findings_details) | **GET** /api/dashboards/system-device-findings-details | System Device Findings Details
|
|
180
|
+
*EmassClient::EnterpriseVulnerabilityDashboardsApi* | [**get_system_device_findings_summary**](docs/EnterpriseVulnerabilityDashboardsApi.md#get_system_device_findings_summary) | **GET** /api/dashboards/system-device-findings-summary | System Device Findings Summary
|
|
181
|
+
*EmassClient::EnterpriseVulnerabilityDashboardsApi* | [**get_system_vulnerability_summary**](docs/EnterpriseVulnerabilityDashboardsApi.md#get_system_vulnerability_summary) | **GET** /api/dashboards/system-vulnerability-summary | System Vulnerability Summary
|
|
182
|
+
*EmassClient::FISMAInventorySummaryDashboardsApi* | [**get_va_system_fisma_invetory_crypto_summary**](docs/FISMAInventorySummaryDashboardsApi.md#get_va_system_fisma_invetory_crypto_summary) | **GET** /api/dashboards/va-system-fisma-inventory-crypto-summary | VA System FISMA Inventory Crypto Summary
|
|
183
|
+
*EmassClient::FISMAInventorySummaryDashboardsApi* | [**get_va_system_fisma_invetory_summary**](docs/FISMAInventorySummaryDashboardsApi.md#get_va_system_fisma_invetory_summary) | **GET** /api/dashboards/va-system-fisma-inventory-summary | VA System FISMA Inventory Summary
|
|
184
|
+
*EmassClient::HardwareBaselineDashboardsApi* | [**get_system_hardware_details**](docs/HardwareBaselineDashboardsApi.md#get_system_hardware_details) | **GET** /api/dashboards/system-hardware-details | System Hardware Details
|
|
185
|
+
*EmassClient::HardwareBaselineDashboardsApi* | [**get_system_hardware_summary**](docs/HardwareBaselineDashboardsApi.md#get_system_hardware_summary) | **GET** /api/dashboards/system-hardware-summary | System Hardware Summary
|
|
194
186
|
*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
|
|
195
187
|
*EmassClient::MilestonesApi* | [**delete_milestone**](docs/MilestonesApi.md#delete_milestone) | **DELETE** /api/systems/{systemId}/poams/{poamId}/milestones | Remove milestones in a system for one or many POA&M items
|
|
196
188
|
*EmassClient::MilestonesApi* | [**get_system_milestones_by_poam_id**](docs/MilestonesApi.md#get_system_milestones_by_poam_id) | **GET** /api/systems/{systemId}/poams/{poamId}/milestones | Get milestones in one or many POA&M items in a system
|
|
197
189
|
*EmassClient::MilestonesApi* | [**get_system_milestones_by_poam_id_and_milestone_id**](docs/MilestonesApi.md#get_system_milestones_by_poam_id_and_milestone_id) | **GET** /api/systems/{systemId}/poams/{poamId}/milestones/{milestoneId} | Get milestone by ID in POA&M item in a system
|
|
198
190
|
*EmassClient::MilestonesApi* | [**update_milestone_by_system_id_and_poam_id**](docs/MilestonesApi.md#update_milestone_by_system_id_and_poam_id) | **PUT** /api/systems/{systemId}/poams/{poamId}/milestones | Update one or many POA&M items in a system
|
|
199
|
-
*EmassClient::PACApi* | [**add_system_pac**](docs/PACApi.md#add_system_pac) | **POST** /api/systems/{systemId}/approval/pac |
|
|
200
|
-
*EmassClient::PACApi* | [**get_system_pac**](docs/PACApi.md#get_system_pac) | **GET** /api/systems/{systemId}/approval/pac | Get
|
|
191
|
+
*EmassClient::PACApi* | [**add_system_pac**](docs/PACApi.md#add_system_pac) | **POST** /api/systems/{systemId}/approval/pac | Initiate system workflow for review
|
|
192
|
+
*EmassClient::PACApi* | [**get_system_pac**](docs/PACApi.md#get_system_pac) | **GET** /api/systems/{systemId}/approval/pac | Get status of active workflows in a system
|
|
201
193
|
*EmassClient::POAMApi* | [**add_poam_by_system_id**](docs/POAMApi.md#add_poam_by_system_id) | **POST** /api/systems/{systemId}/poams | Add one or many POA&M items in a system
|
|
202
194
|
*EmassClient::POAMApi* | [**delete_poam**](docs/POAMApi.md#delete_poam) | **DELETE** /api/systems/{systemId}/poams | Remove one or many POA&M items in a system
|
|
203
195
|
*EmassClient::POAMApi* | [**get_system_poams**](docs/POAMApi.md#get_system_poams) | **GET** /api/systems/{systemId}/poams | Get one or many POA&M items in a system
|
|
204
196
|
*EmassClient::POAMApi* | [**get_system_poams_by_poam_id**](docs/POAMApi.md#get_system_poams_by_poam_id) | **GET** /api/systems/{systemId}/poams/{poamId} | Get POA&M item by ID in a system
|
|
205
197
|
*EmassClient::POAMApi* | [**update_poam_by_system_id**](docs/POAMApi.md#update_poam_by_system_id) | **PUT** /api/systems/{systemId}/poams | Update one or many POA&M items in a system
|
|
198
|
+
*EmassClient::PortsAndProtocolsDashboardsApi* | [**get_system_ports_protocols_details**](docs/PortsAndProtocolsDashboardsApi.md#get_system_ports_protocols_details) | **GET** /api/dashboards/system-ports-protocols-details | System Ports/Protocols Details
|
|
199
|
+
*EmassClient::PortsAndProtocolsDashboardsApi* | [**get_system_ports_protocols_summary**](docs/PortsAndProtocolsDashboardsApi.md#get_system_ports_protocols_summary) | **GET** /api/dashboards/system-ports-protocols-summary | System Ports/Protocols Summary
|
|
200
|
+
*EmassClient::PrivacyComplianceDashboardsApi* | [**get_system_privacy_summary**](docs/PrivacyComplianceDashboardsApi.md#get_system_privacy_summary) | **GET** /api/dashboards/system-privacy-summary | System Privacy Summary
|
|
201
|
+
*EmassClient::PrivacyComplianceDashboardsApi* | [**get_va_omb_fsma_saop_summary**](docs/PrivacyComplianceDashboardsApi.md#get_va_omb_fsma_saop_summary) | **GET** /api/dashboards/va-omb-fisma-saop-summary | VA OMB FISMA SAOP Summary
|
|
206
202
|
*EmassClient::RegistrationApi* | [**register_user**](docs/RegistrationApi.md#register_user) | **POST** /api/api-key | Register user certificate and obtain an API key
|
|
203
|
+
*EmassClient::SoftwareBaselineDashboardsApi* | [**get_system_software_details**](docs/SoftwareBaselineDashboardsApi.md#get_system_software_details) | **GET** /api/dashboards/system-software-details | System Software Details
|
|
204
|
+
*EmassClient::SoftwareBaselineDashboardsApi* | [**get_system_software_summary**](docs/SoftwareBaselineDashboardsApi.md#get_system_software_summary) | **GET** /api/dashboards/system-software-summary | System Software Summary
|
|
207
205
|
*EmassClient::StaticCodeScansApi* | [**add_static_code_scans_by_system_id**](docs/StaticCodeScansApi.md#add_static_code_scans_by_system_id) | **POST** /api/systems/{systemId}/static-code-scans | Upload static code scans or Clear static code scans
|
|
206
|
+
*EmassClient::SystemA20SummaryDashboardApi* | [**get_va_system_a2_summary**](docs/SystemA20SummaryDashboardApi.md#get_va_system_a2_summary) | **GET** /api/dashboards/va-system-a2-summary | VA System A2.0 Summary
|
|
207
|
+
*EmassClient::SystemAASummaryDashboardApi* | [**get_va_system_aa_summary**](docs/SystemAASummaryDashboardApi.md#get_va_system_aa_summary) | **GET** /api/dashboards/va-system-aa-summary | VA System A&A Summary
|
|
208
|
+
*EmassClient::SystemAssociationsDashboardApi* | [**get_system_associations_details**](docs/SystemAssociationsDashboardApi.md#get_system_associations_details) | **GET** /api/dashboards/system-associations-details | System Associations Details
|
|
209
|
+
*EmassClient::SystemCONMONIntegrationStatusDashboardApi* | [**get_system_common_integration_status_summary**](docs/SystemCONMONIntegrationStatusDashboardApi.md#get_system_common_integration_status_summary) | **GET** /api/dashboards/system-conmon-integration-status-summary | System CONMON Integration Status
|
|
210
|
+
*EmassClient::SystemPL109ReportingSummaryDashboardApi* | [**get_va_system_pl109_reporting_summary**](docs/SystemPL109ReportingSummaryDashboardApi.md#get_va_system_pl109_reporting_summary) | **GET** /api/dashboards/va-system-pl-109-reporting-summary | VA System P.L. 109 Reporting Summary
|
|
208
211
|
*EmassClient::SystemRolesApi* | [**get_system_roles**](docs/SystemRolesApi.md#get_system_roles) | **GET** /api/system-roles | Get available roles
|
|
209
212
|
*EmassClient::SystemRolesApi* | [**get_system_roles_by_category_id**](docs/SystemRolesApi.md#get_system_roles_by_category_id) | **GET** /api/system-roles/{roleCategory} | Get system roles
|
|
213
|
+
*EmassClient::SystemStatusDashboardApi* | [**get_system_status_details**](docs/SystemStatusDashboardApi.md#get_system_status_details) | **GET** /api/dashboards/system-status-details | System Status Details
|
|
210
214
|
*EmassClient::SystemsApi* | [**get_system**](docs/SystemsApi.md#get_system) | **GET** /api/systems/{systemId} | Get system information for a specific system
|
|
211
215
|
*EmassClient::SystemsApi* | [**get_systems**](docs/SystemsApi.md#get_systems) | **GET** /api/systems | Get system information
|
|
212
216
|
*EmassClient::TestApi* | [**test_connection**](docs/TestApi.md#test_connection) | **GET** /api | Test connection to the API
|
|
213
217
|
*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
|
|
214
218
|
*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
|
|
219
|
+
*EmassClient::ThreatRisksDashboardsApi* | [**get_va_system_threat_architecture_details**](docs/ThreatRisksDashboardsApi.md#get_va_system_threat_architecture_details) | **GET** /api/dashboards/va-system-threat-architecture-details | VA System Threat Architecture Details
|
|
220
|
+
*EmassClient::ThreatRisksDashboardsApi* | [**get_va_system_threat_risk_summary**](docs/ThreatRisksDashboardsApi.md#get_va_system_threat_risk_summary) | **GET** /api/dashboards/va-system-threat-risks-summary | VA System Threat Risks Summary
|
|
221
|
+
*EmassClient::ThreatRisksDashboardsApi* | [**get_va_system_threat_source_details**](docs/ThreatRisksDashboardsApi.md#get_va_system_threat_source_details) | **GET** /api/dashboards/va-system-threat-sources-details | VA System Threat Sources Details
|
|
222
|
+
*EmassClient::UsersDashboardApi* | [**get_user_system_assignments_details**](docs/UsersDashboardApi.md#get_user_system_assignments_details) | **GET** /api/dashboards/user-system-assignments-details | User System Assignments Details
|
|
215
223
|
*EmassClient::WorkflowDefinitionsApi* | [**get_workflow_definitions**](docs/WorkflowDefinitionsApi.md#get_workflow_definitions) | **GET** /api/workflows/definitions | Get workflow definitions in a site
|
|
216
224
|
*EmassClient::WorkflowInstancesApi* | [**get_system_workflow_instances**](docs/WorkflowInstancesApi.md#get_system_workflow_instances) | **GET** /api/workflows/instances | Get workflow instances in a site
|
|
217
225
|
*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
|
|
@@ -230,12 +238,16 @@ Class | Method | HTTP request | Description
|
|
|
230
238
|
- [EmassClient::CacResponseGet](docs/CacResponseGet.md)
|
|
231
239
|
- [EmassClient::CacResponsePost](docs/CacResponsePost.md)
|
|
232
240
|
- [EmassClient::CacResponsePostDataInner](docs/CacResponsePostDataInner.md)
|
|
233
|
-
- [EmassClient::
|
|
241
|
+
- [EmassClient::CloudResourcesDelete](docs/CloudResourcesDelete.md)
|
|
242
|
+
- [EmassClient::CloudResourcesDeleteBodyInner](docs/CloudResourcesDeleteBodyInner.md)
|
|
243
|
+
- [EmassClient::CloudResourcesPostDelete](docs/CloudResourcesPostDelete.md)
|
|
234
244
|
- [EmassClient::CloudResourcesResponsePost](docs/CloudResourcesResponsePost.md)
|
|
235
245
|
- [EmassClient::CmmcGet](docs/CmmcGet.md)
|
|
236
246
|
- [EmassClient::CmmcResponseGet](docs/CmmcResponseGet.md)
|
|
237
247
|
- [EmassClient::ConnectivityCcsd](docs/ConnectivityCcsd.md)
|
|
238
|
-
- [EmassClient::
|
|
248
|
+
- [EmassClient::ContainerResourcesDeleteBodyInner](docs/ContainerResourcesDeleteBodyInner.md)
|
|
249
|
+
- [EmassClient::ContainersResourcesPostDelete](docs/ContainersResourcesPostDelete.md)
|
|
250
|
+
- [EmassClient::ContainersResponseDelete](docs/ContainersResponseDelete.md)
|
|
239
251
|
- [EmassClient::ContainersResponsePost](docs/ContainersResponsePost.md)
|
|
240
252
|
- [EmassClient::ControlsGet](docs/ControlsGet.md)
|
|
241
253
|
- [EmassClient::ControlsPut](docs/ControlsPut.md)
|
|
@@ -245,6 +257,7 @@ Class | Method | HTTP request | Description
|
|
|
245
257
|
- [EmassClient::DashboardMockResponsePagination](docs/DashboardMockResponsePagination.md)
|
|
246
258
|
- [EmassClient::DefinitionTransitions](docs/DefinitionTransitions.md)
|
|
247
259
|
- [EmassClient::InstancesTransitions](docs/InstancesTransitions.md)
|
|
260
|
+
- [EmassClient::MilestoneResponseDelete](docs/MilestoneResponseDelete.md)
|
|
248
261
|
- [EmassClient::MilestoneResponseGet](docs/MilestoneResponseGet.md)
|
|
249
262
|
- [EmassClient::MilestoneResponseGetMilestone](docs/MilestoneResponseGetMilestone.md)
|
|
250
263
|
- [EmassClient::MilestoneResponsePost](docs/MilestoneResponsePost.md)
|
|
@@ -292,7 +305,7 @@ Class | Method | HTTP request | Description
|
|
|
292
305
|
- [EmassClient::Roles](docs/Roles.md)
|
|
293
306
|
- [EmassClient::Ssps](docs/Ssps.md)
|
|
294
307
|
- [EmassClient::Stage](docs/Stage.md)
|
|
295
|
-
- [EmassClient::
|
|
308
|
+
- [EmassClient::StaticCodeApplicationPost](docs/StaticCodeApplicationPost.md)
|
|
296
309
|
- [EmassClient::StaticCodePost](docs/StaticCodePost.md)
|
|
297
310
|
- [EmassClient::StaticCodeRequestPostBody](docs/StaticCodeRequestPostBody.md)
|
|
298
311
|
- [EmassClient::StaticCodeRequestPostBodyApplication](docs/StaticCodeRequestPostBodyApplication.md)
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Enterprise Mission Assurance Support Service (eMASS)
|
|
3
3
|
|
|
4
|
-
#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. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) 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). Use the `Registration` endpoint to register the client certificate
|
|
4
|
+
#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. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) 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). Use the `Registration` POST endpoint to register the client certificate. The endpoint call returns the user `api-key`.</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:
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v3.
|
|
6
|
+
The version of the OpenAPI document: v3.12
|
|
7
7
|
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 7.
|
|
9
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ module EmassClient
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Add one or many artifacts in a system
|
|
23
|
-
# <strong>Information</strong><br> The body of a request through the Artifacts POST endpoint accepts a single binary file. Two Artifact POST methods are currently accepted: individual and bulk. Filename uniqueness within an eMASS system will be enforced by the API for both methods. <br><br> For POST requests that should result in a single artifact, the request should include the file. <br><br> For POST requests that should result in the creation of many artifacts, the request should include a single file with the extension \".zip\" only and the parameter isBulk should be set to true. This .zip file should contain one or more files corresponding to existing artifacts or new artifacts that will be created upon successful receipt. <br><br> Upon successful receipt of one or many artifacts, if a file is matched via filename to an artifact existing within the application, the file associated with the artifact will be updated. If no artifact is matched via filename to the application, a new artifact will be created with the following default values. Any values not specified below will be null <ul> <li>isTemplate: false</li> <li>type: Other</li> <li>category: Evidence</li> </ul> To update values other than the file itself, please submit a PUT request.<br> <strong>Business Rules</strong><br> Artifact cannot be saved if the fields below exceed the following character limits: <ul> <li>Filename - 1,000 characters</li> <li>Name - 100 characters</li> <li>Description - 10,000 characters</li> <li>Reference Page Number - 50 characters</li> </ul> Artifact cannot be saved if the file does not have an allowable file extension/type: .docx,.doc,.txt,.rtf,.xfdl,.xml,.mht,.mh,tml,.html,.htm,.pdf,.mdb,.accdb,.ppt, .pptx,.xls,.xlsx,.csv,.log,.jpeg,.jpg,.tiff,.bmp,.tif,.png,.gif,.zip,.rar,.msg, .vsd,.vsw,.vdx,.z{#},.ckl,.avi,.vsdx Artifact version cannot be saved if an Artifact with the same file name already exist in the system. Artifact cannot be saved if the file size exceeds 30MB. Artifact cannot be saved if the following fields are missing data: <ul> <li>Filename</li> <li>Type</li> <li>Category</li> </ul> Artifact cannot be saved if the Last Review Date (`lastReviewedDate`) is set in the future.
|
|
23
|
+
# <strong>Information</strong><br> The body of a request through the Artifacts POST endpoint accepts a single binary file. Two Artifact POST methods are currently accepted: individual and bulk. Filename uniqueness within an eMASS system will be enforced by the API for both methods. <br><br> For POST requests that should result in a single artifact, the request should include the file. <br><br> For POST requests that should result in the creation of many artifacts, the request should include a single file with the extension \".zip\" only and the parameter isBulk should be set to true. This .zip file should contain one or more files corresponding to existing artifacts or new artifacts that will be created upon successful receipt. <br><br> Upon successful receipt of one or many artifacts, if a file is matched via filename to an artifact existing within the application, the file associated with the artifact will be updated. If no artifact is matched via filename to the application, a new artifact will be created with the following default values. Any values not specified below will be null <ul> <li>isTemplate: false</li> <li>type: Other</li> <li>category: Evidence</li> </ul> To update values other than the file itself, please submit a PUT request.<br> <strong>Business Rules</strong><br> Artifact cannot be saved if the fields below exceed the following character limits: <ul> <li>Filename - 1,000 characters</li> <li>Name - 100 characters</li> <li>Description - 10,000 characters</li> <li>Reference Page Number - 50 characters</li> </ul> Artifact cannot be saved if the file does not have an allowable file extension/type: .docx,.doc,.txt,.rtf,.xfdl,.xml,.mht,.mh,tml,.html,.htm,.pdf,.mdb,.accdb,.ppt, .pptx,.xls,.xlsx,.csv,.log,.jpeg,.jpg,.tiff,.bmp,.tif,.png,.gif,.zip,.rar,.msg, .vsd,.vsw,.vdx,.z{#},.ckl,.avi,.vsdx Artifact version cannot be saved if an Artifact with the same file name (filename) already exist in the system. Artifact cannot be saved if the file size exceeds 30MB. Artifact cannot be saved if the following fields are missing data: <ul> <li>Filename (filename)</li> <li>Type (type)</li> <li>Category (category)</li> </ul> Artifact cannot be saved if the Last Review Date (`lastReviewedDate`) is set in the future.
|
|
24
24
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
25
25
|
# @param zipper [File]
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
@@ -35,7 +35,7 @@ module EmassClient
|
|
|
35
35
|
end
|
|
36
36
|
|
|
37
37
|
# Add one or many artifacts in a system
|
|
38
|
-
# <strong>Information</strong><br> The body of a request through the Artifacts POST endpoint accepts a single binary file. Two Artifact POST methods are currently accepted: individual and bulk. Filename uniqueness within an eMASS system will be enforced by the API for both methods. <br><br> For POST requests that should result in a single artifact, the request should include the file. <br><br> For POST requests that should result in the creation of many artifacts, the request should include a single file with the extension \".zip\" only and the parameter isBulk should be set to true. This .zip file should contain one or more files corresponding to existing artifacts or new artifacts that will be created upon successful receipt. <br><br> Upon successful receipt of one or many artifacts, if a file is matched via filename to an artifact existing within the application, the file associated with the artifact will be updated. If no artifact is matched via filename to the application, a new artifact will be created with the following default values. Any values not specified below will be null <ul> <li>isTemplate: false</li> <li>type: Other</li> <li>category: Evidence</li> </ul> To update values other than the file itself, please submit a PUT request.<br> <strong>Business Rules</strong><br> Artifact cannot be saved if the fields below exceed the following character limits: <ul> <li>Filename - 1,000 characters</li> <li>Name - 100 characters</li> <li>Description - 10,000 characters</li> <li>Reference Page Number - 50 characters</li> </ul> Artifact cannot be saved if the file does not have an allowable file extension/type: .docx,.doc,.txt,.rtf,.xfdl,.xml,.mht,.mh,tml,.html,.htm,.pdf,.mdb,.accdb,.ppt, .pptx,.xls,.xlsx,.csv,.log,.jpeg,.jpg,.tiff,.bmp,.tif,.png,.gif,.zip,.rar,.msg, .vsd,.vsw,.vdx,.z{#},.ckl,.avi,.vsdx Artifact version cannot be saved if an Artifact with the same file name already exist in the system. Artifact cannot be saved if the file size exceeds 30MB. Artifact cannot be saved if the following fields are missing data: <ul> <li>Filename</li> <li>Type</li> <li>Category</li> </ul> Artifact cannot be saved if the Last Review Date (`lastReviewedDate`) is set in the future.
|
|
38
|
+
# <strong>Information</strong><br> The body of a request through the Artifacts POST endpoint accepts a single binary file. Two Artifact POST methods are currently accepted: individual and bulk. Filename uniqueness within an eMASS system will be enforced by the API for both methods. <br><br> For POST requests that should result in a single artifact, the request should include the file. <br><br> For POST requests that should result in the creation of many artifacts, the request should include a single file with the extension \".zip\" only and the parameter isBulk should be set to true. This .zip file should contain one or more files corresponding to existing artifacts or new artifacts that will be created upon successful receipt. <br><br> Upon successful receipt of one or many artifacts, if a file is matched via filename to an artifact existing within the application, the file associated with the artifact will be updated. If no artifact is matched via filename to the application, a new artifact will be created with the following default values. Any values not specified below will be null <ul> <li>isTemplate: false</li> <li>type: Other</li> <li>category: Evidence</li> </ul> To update values other than the file itself, please submit a PUT request.<br> <strong>Business Rules</strong><br> Artifact cannot be saved if the fields below exceed the following character limits: <ul> <li>Filename - 1,000 characters</li> <li>Name - 100 characters</li> <li>Description - 10,000 characters</li> <li>Reference Page Number - 50 characters</li> </ul> Artifact cannot be saved if the file does not have an allowable file extension/type: .docx,.doc,.txt,.rtf,.xfdl,.xml,.mht,.mh,tml,.html,.htm,.pdf,.mdb,.accdb,.ppt, .pptx,.xls,.xlsx,.csv,.log,.jpeg,.jpg,.tiff,.bmp,.tif,.png,.gif,.zip,.rar,.msg, .vsd,.vsw,.vdx,.z{#},.ckl,.avi,.vsdx Artifact version cannot be saved if an Artifact with the same file name (filename) already exist in the system. Artifact cannot be saved if the file size exceeds 30MB. Artifact cannot be saved if the following fields are missing data: <ul> <li>Filename (filename)</li> <li>Type (type)</li> <li>Category (category)</li> </ul> Artifact cannot be saved if the Last Review Date (`lastReviewedDate`) is set in the future.
|
|
39
39
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
40
40
|
# @param zipper [File]
|
|
41
41
|
# @param [Hash] opts the optional parameters
|
|
@@ -193,8 +193,9 @@ module EmassClient
|
|
|
193
193
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
194
194
|
# @param [Hash] opts the optional parameters
|
|
195
195
|
# @option opts [String] :filename **File Name**: The file name (to include file-extension).
|
|
196
|
-
# @option opts [String] :control_acronyms **
|
|
197
|
-
# @option opts [String] :
|
|
196
|
+
# @option opts [String] :control_acronyms **Control Acronym**: Filter query by given system acronym (single value or comma separated).
|
|
197
|
+
# @option opts [String] :assessment_procedures **Assessment Procedure**: Filter query by given Security Control Assessment Procedure (single value or comma separated).
|
|
198
|
+
# @option opts [String] :ccis **CCI System**: Filter query by Control Correlation Identifiers (CCIs) (single value or comma separated).
|
|
198
199
|
# @option opts [Boolean] :system_only **Systems Only**: Indicates that only system(s) information is retrieved. (default to true)
|
|
199
200
|
# @return [ArtifactsResponseGet]
|
|
200
201
|
def get_system_artifacts(system_id, opts = {})
|
|
@@ -207,8 +208,9 @@ module EmassClient
|
|
|
207
208
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
208
209
|
# @param [Hash] opts the optional parameters
|
|
209
210
|
# @option opts [String] :filename **File Name**: The file name (to include file-extension).
|
|
210
|
-
# @option opts [String] :control_acronyms **
|
|
211
|
-
# @option opts [String] :
|
|
211
|
+
# @option opts [String] :control_acronyms **Control Acronym**: Filter query by given system acronym (single value or comma separated).
|
|
212
|
+
# @option opts [String] :assessment_procedures **Assessment Procedure**: Filter query by given Security Control Assessment Procedure (single value or comma separated).
|
|
213
|
+
# @option opts [String] :ccis **CCI System**: Filter query by Control Correlation Identifiers (CCIs) (single value or comma separated).
|
|
212
214
|
# @option opts [Boolean] :system_only **Systems Only**: Indicates that only system(s) information is retrieved. (default to true)
|
|
213
215
|
# @return [Array<(ArtifactsResponseGet, Integer, Hash)>] ArtifactsResponseGet data, response status code and response headers
|
|
214
216
|
def get_system_artifacts_with_http_info(system_id, opts = {})
|
|
@@ -226,6 +228,7 @@ module EmassClient
|
|
|
226
228
|
query_params = opts[:query_params] || {}
|
|
227
229
|
query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?
|
|
228
230
|
query_params[:'controlAcronyms'] = opts[:'control_acronyms'] if !opts[:'control_acronyms'].nil?
|
|
231
|
+
query_params[:'assessmentProcedures'] = opts[:'assessment_procedures'] if !opts[:'assessment_procedures'].nil?
|
|
229
232
|
query_params[:'ccis'] = opts[:'ccis'] if !opts[:'ccis'].nil?
|
|
230
233
|
query_params[:'systemOnly'] = opts[:'system_only'] if !opts[:'system_only'].nil?
|
|
231
234
|
|
|
@@ -264,7 +267,7 @@ module EmassClient
|
|
|
264
267
|
end
|
|
265
268
|
|
|
266
269
|
# Update one or many artifacts in a system
|
|
267
|
-
# Updates an artifact for given `systemId` path parameter<br><br> **Request Body Required Fields** - `filename` - `isTemplate` - `type` - `category`
|
|
270
|
+
# Updates an artifact for given `systemId` path parameter<br><br> **Request Body Required Fields** - `filename` - `isTemplate` - `type` - `category` <strong>Information</strong><br> The PUT request will replace all existing data with the field/value combinations included in the request body. If any fields are not included, the absent fields will become null. The fields `name` and `isTemplate` are non-nullable fields. If not specified in the PUT command they will default to the following: - `name=filename` - `isTemplate=false` Also, note that one-to-many fields (`controls` and `ccis`) will also be replaced with the values specified in the PUT. If existing `control or cci` mappings exist in eMASS, the values in the PUT will not append, but rather replace all existing control and cci mappings with the values in the request body.
|
|
268
271
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
269
272
|
# @param request_body [Array<Object>] See `information` above for additional instructions
|
|
270
273
|
# @param [Hash] opts the optional parameters
|
|
@@ -275,7 +278,7 @@ module EmassClient
|
|
|
275
278
|
end
|
|
276
279
|
|
|
277
280
|
# Update one or many artifacts in a system
|
|
278
|
-
# Updates an artifact for given `systemId` path parameter<br><br> **Request Body Required Fields** - `filename` - `isTemplate` - `type` - `category`
|
|
281
|
+
# Updates an artifact for given `systemId` path parameter<br><br> **Request Body Required Fields** - `filename` - `isTemplate` - `type` - `category` <strong>Information</strong><br> The PUT request will replace all existing data with the field/value combinations included in the request body. If any fields are not included, the absent fields will become null. The fields `name` and `isTemplate` are non-nullable fields. If not specified in the PUT command they will default to the following: - `name=filename` - `isTemplate=false` Also, note that one-to-many fields (`controls` and `ccis`) will also be replaced with the values specified in the PUT. If existing `control or cci` mappings exist in eMASS, the values in the PUT will not append, but rather replace all existing control and cci mappings with the values in the request body.
|
|
279
282
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
280
283
|
# @param request_body [Array<Object>] See `information` above for additional instructions
|
|
281
284
|
# @param [Hash] opts the optional parameters
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Enterprise Mission Assurance Support Service (eMASS)
|
|
3
3
|
|
|
4
|
-
#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. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) 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). Use the `Registration` endpoint to register the client certificate
|
|
4
|
+
#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. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) 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). Use the `Registration` POST endpoint to register the client certificate. The endpoint call returns the user `api-key`.</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:
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v3.
|
|
6
|
+
The version of the OpenAPI document: v3.12
|
|
7
7
|
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 7.
|
|
9
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Enterprise Mission Assurance Support Service (eMASS)
|
|
3
3
|
|
|
4
|
-
#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. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) 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). Use the `Registration` endpoint to register the client certificate
|
|
4
|
+
#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. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) 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). Use the `Registration` POST endpoint to register the client certificate. The endpoint call returns the user `api-key`.</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:
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v3.
|
|
6
|
+
The version of the OpenAPI document: v3.12
|
|
7
7
|
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 7.
|
|
9
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ module EmassClient
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Submit control to second role of CAC
|
|
23
|
-
#
|
|
23
|
+
# **Request Body Required Fields** - `controlAcronym` - `comments` **Notes:** - Comments `comments` are not required at the first role of the CAC but are required at the second role of the CAC. Comments cannot exceed 10,000 characters. - POST requests will only yield successful results if the control is currently sitting at the first role of the CAC. If the control is not currently sitting at the first role, then an error will be returned.
|
|
24
24
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
25
25
|
# @param request_body [Array<Object>] Add control(s) to second role of CAC
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
@@ -31,7 +31,7 @@ module EmassClient
|
|
|
31
31
|
end
|
|
32
32
|
|
|
33
33
|
# Submit control to second role of CAC
|
|
34
|
-
#
|
|
34
|
+
# **Request Body Required Fields** - `controlAcronym` - `comments` **Notes:** - Comments `comments` are not required at the first role of the CAC but are required at the second role of the CAC. Comments cannot exceed 10,000 characters. - POST requests will only yield successful results if the control is currently sitting at the first role of the CAC. If the control is not currently sitting at the first role, then an error will be returned.
|
|
35
35
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
36
36
|
# @param request_body [Array<Object>] Add control(s) to second role of CAC
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
@@ -97,7 +97,7 @@ module EmassClient
|
|
|
97
97
|
# Returns the location of a system's package in the Control Approval Chain (CAC) for matching `systemId` path parameter
|
|
98
98
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
99
99
|
# @param [Hash] opts the optional parameters
|
|
100
|
-
# @option opts [String] :control_acronyms **
|
|
100
|
+
# @option opts [String] :control_acronyms **Control Acronym**: Filter query by given system acronym (single value or comma separated).
|
|
101
101
|
# @return [CacResponseGet]
|
|
102
102
|
def get_system_cac(system_id, opts = {})
|
|
103
103
|
data, _status_code, _headers = get_system_cac_with_http_info(system_id, opts)
|
|
@@ -108,7 +108,7 @@ module EmassClient
|
|
|
108
108
|
# Returns the location of a system's package in the Control Approval Chain (CAC) for matching `systemId` path parameter
|
|
109
109
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
110
110
|
# @param [Hash] opts the optional parameters
|
|
111
|
-
# @option opts [String] :control_acronyms **
|
|
111
|
+
# @option opts [String] :control_acronyms **Control Acronym**: Filter query by given system acronym (single value or comma separated).
|
|
112
112
|
# @return [Array<(CacResponseGet, Integer, Hash)>] CacResponseGet data, response status code and response headers
|
|
113
113
|
def get_system_cac_with_http_info(system_id, opts = {})
|
|
114
114
|
if @api_client.config.debugging
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Enterprise Mission Assurance Support Service (eMASS)
|
|
3
3
|
|
|
4
|
-
#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. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) 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). Use the `Registration` endpoint to register the client certificate
|
|
4
|
+
#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. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) 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). Use the `Registration` POST endpoint to register the client certificate. The endpoint call returns the user `api-key`.</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:
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v3.
|
|
6
|
+
The version of the OpenAPI document: v3.12
|
|
7
7
|
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 7.
|
|
9
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ module EmassClient
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Add one or many cloud resources and their scan results
|
|
23
|
-
# Add cloud resources and their scan results in the assets module for a system `systemId`
|
|
23
|
+
# Add cloud resources and their scan results in the assets module for a system `systemId` **Request Body Required Fields** - `provider` - `resourceId` - `resourceName` - `resourceType` - Compliance Results Object Array `complianceResults` - `cspPolicyDefinitionId` - `isCompliant` - `policyDefinitionTitle` **Example Request Body Required Fields** ``` [ { \"provider\": \"provide name\", \"resourceId\": \"resource identification\", \"resourceName\": \"resource name\", \"resourceType\": \"resource type\", \"complianceResults\": [ { \"cspPolicyDefinitionId\": \"CSP policy definition identification\", \"policyDefinitionTitle\": \"policy definition title\", \"isCompliant\": [true or false] } ] } ] ```
|
|
24
24
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
25
25
|
# @param request_body [Array<Object>] Add cloud resources and their scan results
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
@@ -31,7 +31,7 @@ module EmassClient
|
|
|
31
31
|
end
|
|
32
32
|
|
|
33
33
|
# Add one or many cloud resources and their scan results
|
|
34
|
-
# Add cloud resources and their scan results in the assets module for a system `systemId`
|
|
34
|
+
# Add cloud resources and their scan results in the assets module for a system `systemId` **Request Body Required Fields** - `provider` - `resourceId` - `resourceName` - `resourceType` - Compliance Results Object Array `complianceResults` - `cspPolicyDefinitionId` - `isCompliant` - `policyDefinitionTitle` **Example Request Body Required Fields** ``` [ { \"provider\": \"provide name\", \"resourceId\": \"resource identification\", \"resourceName\": \"resource name\", \"resourceType\": \"resource type\", \"complianceResults\": [ { \"cspPolicyDefinitionId\": \"CSP policy definition identification\", \"policyDefinitionTitle\": \"policy definition title\", \"isCompliant\": [true or false] } ] } ] ```
|
|
35
35
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
36
36
|
# @param request_body [Array<Object>] Add cloud resources and their scan results
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
@@ -92,5 +92,79 @@ module EmassClient
|
|
|
92
92
|
end
|
|
93
93
|
return data, status_code, headers
|
|
94
94
|
end
|
|
95
|
+
|
|
96
|
+
# Remove one or many cloud resources in a system
|
|
97
|
+
# Removes cloud resources and their scan results in the assets module for a system `systemId`
|
|
98
|
+
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
99
|
+
# @param cloud_resources_delete_body_inner [Array<CloudResourcesDeleteBodyInner>] Delete the given Cloud Resource Id
|
|
100
|
+
# @param [Hash] opts the optional parameters
|
|
101
|
+
# @return [CloudResourcesDelete]
|
|
102
|
+
def delete_cloud_resources(system_id, cloud_resources_delete_body_inner, opts = {})
|
|
103
|
+
data, _status_code, _headers = delete_cloud_resources_with_http_info(system_id, cloud_resources_delete_body_inner, opts)
|
|
104
|
+
data
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
# Remove one or many cloud resources in a system
|
|
108
|
+
# Removes cloud resources and their scan results in the assets module for a system `systemId`
|
|
109
|
+
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
|
110
|
+
# @param cloud_resources_delete_body_inner [Array<CloudResourcesDeleteBodyInner>] Delete the given Cloud Resource Id
|
|
111
|
+
# @param [Hash] opts the optional parameters
|
|
112
|
+
# @return [Array<(CloudResourcesDelete, Integer, Hash)>] CloudResourcesDelete data, response status code and response headers
|
|
113
|
+
def delete_cloud_resources_with_http_info(system_id, cloud_resources_delete_body_inner, opts = {})
|
|
114
|
+
if @api_client.config.debugging
|
|
115
|
+
@api_client.config.logger.debug 'Calling API: CloudResourceResultsApi.delete_cloud_resources ...'
|
|
116
|
+
end
|
|
117
|
+
# verify the required parameter 'system_id' is set
|
|
118
|
+
if @api_client.config.client_side_validation && system_id.nil?
|
|
119
|
+
fail ArgumentError, "Missing the required parameter 'system_id' when calling CloudResourceResultsApi.delete_cloud_resources"
|
|
120
|
+
end
|
|
121
|
+
# verify the required parameter 'cloud_resources_delete_body_inner' is set
|
|
122
|
+
if @api_client.config.client_side_validation && cloud_resources_delete_body_inner.nil?
|
|
123
|
+
fail ArgumentError, "Missing the required parameter 'cloud_resources_delete_body_inner' when calling CloudResourceResultsApi.delete_cloud_resources"
|
|
124
|
+
end
|
|
125
|
+
# resource path
|
|
126
|
+
local_var_path = '/api/systems/{systemId}/cloud-resource-results'.sub('{' + 'systemId' + '}', CGI.escape(system_id.to_s))
|
|
127
|
+
|
|
128
|
+
# query parameters
|
|
129
|
+
query_params = opts[:query_params] || {}
|
|
130
|
+
|
|
131
|
+
# header parameters
|
|
132
|
+
header_params = opts[:header_params] || {}
|
|
133
|
+
# HTTP header 'Accept' (if needed)
|
|
134
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
135
|
+
# HTTP header 'Content-Type'
|
|
136
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
137
|
+
if !content_type.nil?
|
|
138
|
+
header_params['Content-Type'] = content_type
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
# form parameters
|
|
142
|
+
form_params = opts[:form_params] || {}
|
|
143
|
+
|
|
144
|
+
# http body (model)
|
|
145
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cloud_resources_delete_body_inner)
|
|
146
|
+
|
|
147
|
+
# return_type
|
|
148
|
+
return_type = opts[:debug_return_type] || 'CloudResourcesDelete'
|
|
149
|
+
|
|
150
|
+
# auth_names
|
|
151
|
+
auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
|
|
152
|
+
|
|
153
|
+
new_options = opts.merge(
|
|
154
|
+
:operation => :"CloudResourceResultsApi.delete_cloud_resources",
|
|
155
|
+
:header_params => header_params,
|
|
156
|
+
:query_params => query_params,
|
|
157
|
+
:form_params => form_params,
|
|
158
|
+
:body => post_body,
|
|
159
|
+
:auth_names => auth_names,
|
|
160
|
+
:return_type => return_type
|
|
161
|
+
)
|
|
162
|
+
|
|
163
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
164
|
+
if @api_client.config.debugging
|
|
165
|
+
@api_client.config.logger.debug "API called: CloudResourceResultsApi#delete_cloud_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
166
|
+
end
|
|
167
|
+
return data, status_code, headers
|
|
168
|
+
end
|
|
95
169
|
end
|
|
96
170
|
end
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Enterprise Mission Assurance Support Service (eMASS)
|
|
3
3
|
|
|
4
|
-
#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. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) 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). Use the `Registration` endpoint to register the client certificate
|
|
4
|
+
#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. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) 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). Use the `Registration` POST endpoint to register the client certificate. The endpoint call returns the user `api-key`.</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:
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: v3.
|
|
6
|
+
The version of the OpenAPI document: v3.12
|
|
7
7
|
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 7.
|
|
9
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|