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
@@ -0,0 +1,168 @@
|
|
1
|
+
=begin
|
2
|
+
#Enterprise Mission Assurance Support Service (eMASS)
|
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` 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
|
+
|
6
|
+
The version of the OpenAPI document: v3.12
|
7
|
+
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module EmassClient
|
16
|
+
class HardwareBaselineDashboardsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# System Hardware Details
|
23
|
+
# Get system hardware details dashboard information.
|
24
|
+
# @param org_id [Integer] **Organization Id**: The unique organization identifier.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [Boolean] :excludeinherited **Exclude Inherited**: If no value is specified, the default returns false to include inherited data. (default to false)
|
27
|
+
# @option opts [Integer] :page_index **Page Index**: If no value is specified, the default returns results from the first page with an index of 0. (default to 0)
|
28
|
+
# @option opts [Integer] :page_size **Page Size**: If no value is specified, the default returns 20000 per page. (default to 20000)
|
29
|
+
# @return [Object]
|
30
|
+
def get_system_hardware_details(org_id, opts = {})
|
31
|
+
data, _status_code, _headers = get_system_hardware_details_with_http_info(org_id, opts)
|
32
|
+
data
|
33
|
+
end
|
34
|
+
|
35
|
+
# System Hardware Details
|
36
|
+
# Get system hardware details dashboard information.
|
37
|
+
# @param org_id [Integer] **Organization Id**: The unique organization identifier.
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @option opts [Boolean] :excludeinherited **Exclude Inherited**: If no value is specified, the default returns false to include inherited data. (default to false)
|
40
|
+
# @option opts [Integer] :page_index **Page Index**: If no value is specified, the default returns results from the first page with an index of 0. (default to 0)
|
41
|
+
# @option opts [Integer] :page_size **Page Size**: If no value is specified, the default returns 20000 per page. (default to 20000)
|
42
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
43
|
+
def get_system_hardware_details_with_http_info(org_id, opts = {})
|
44
|
+
if @api_client.config.debugging
|
45
|
+
@api_client.config.logger.debug 'Calling API: HardwareBaselineDashboardsApi.get_system_hardware_details ...'
|
46
|
+
end
|
47
|
+
# verify the required parameter 'org_id' is set
|
48
|
+
if @api_client.config.client_side_validation && org_id.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'org_id' when calling HardwareBaselineDashboardsApi.get_system_hardware_details"
|
50
|
+
end
|
51
|
+
# resource path
|
52
|
+
local_var_path = '/api/dashboards/system-hardware-details'
|
53
|
+
|
54
|
+
# query parameters
|
55
|
+
query_params = opts[:query_params] || {}
|
56
|
+
query_params[:'orgId'] = org_id
|
57
|
+
query_params[:'excludeinherited'] = opts[:'excludeinherited'] if !opts[:'excludeinherited'].nil?
|
58
|
+
query_params[:'pageIndex'] = opts[:'page_index'] if !opts[:'page_index'].nil?
|
59
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
60
|
+
|
61
|
+
# header parameters
|
62
|
+
header_params = opts[:header_params] || {}
|
63
|
+
# HTTP header 'Accept' (if needed)
|
64
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
65
|
+
|
66
|
+
# form parameters
|
67
|
+
form_params = opts[:form_params] || {}
|
68
|
+
|
69
|
+
# http body (model)
|
70
|
+
post_body = opts[:debug_body]
|
71
|
+
|
72
|
+
# return_type
|
73
|
+
return_type = opts[:debug_return_type] || 'Object'
|
74
|
+
|
75
|
+
# auth_names
|
76
|
+
auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
|
77
|
+
|
78
|
+
new_options = opts.merge(
|
79
|
+
:operation => :"HardwareBaselineDashboardsApi.get_system_hardware_details",
|
80
|
+
:header_params => header_params,
|
81
|
+
:query_params => query_params,
|
82
|
+
:form_params => form_params,
|
83
|
+
:body => post_body,
|
84
|
+
:auth_names => auth_names,
|
85
|
+
:return_type => return_type
|
86
|
+
)
|
87
|
+
|
88
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
89
|
+
if @api_client.config.debugging
|
90
|
+
@api_client.config.logger.debug "API called: HardwareBaselineDashboardsApi#get_system_hardware_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
91
|
+
end
|
92
|
+
return data, status_code, headers
|
93
|
+
end
|
94
|
+
|
95
|
+
# System Hardware Summary
|
96
|
+
# Get system hardware summary dashboard information.
|
97
|
+
# @param org_id [Integer] **Organization Id**: The unique organization identifier.
|
98
|
+
# @param [Hash] opts the optional parameters
|
99
|
+
# @option opts [Boolean] :excludeinherited **Exclude Inherited**: If no value is specified, the default returns false to include inherited data. (default to false)
|
100
|
+
# @option opts [Integer] :page_index **Page Index**: If no value is specified, the default returns results from the first page with an index of 0. (default to 0)
|
101
|
+
# @option opts [Integer] :page_size **Page Size**: If no value is specified, the default returns 20000 per page. (default to 20000)
|
102
|
+
# @return [Object]
|
103
|
+
def get_system_hardware_summary(org_id, opts = {})
|
104
|
+
data, _status_code, _headers = get_system_hardware_summary_with_http_info(org_id, opts)
|
105
|
+
data
|
106
|
+
end
|
107
|
+
|
108
|
+
# System Hardware Summary
|
109
|
+
# Get system hardware summary dashboard information.
|
110
|
+
# @param org_id [Integer] **Organization Id**: The unique organization identifier.
|
111
|
+
# @param [Hash] opts the optional parameters
|
112
|
+
# @option opts [Boolean] :excludeinherited **Exclude Inherited**: If no value is specified, the default returns false to include inherited data. (default to false)
|
113
|
+
# @option opts [Integer] :page_index **Page Index**: If no value is specified, the default returns results from the first page with an index of 0. (default to 0)
|
114
|
+
# @option opts [Integer] :page_size **Page Size**: If no value is specified, the default returns 20000 per page. (default to 20000)
|
115
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
116
|
+
def get_system_hardware_summary_with_http_info(org_id, opts = {})
|
117
|
+
if @api_client.config.debugging
|
118
|
+
@api_client.config.logger.debug 'Calling API: HardwareBaselineDashboardsApi.get_system_hardware_summary ...'
|
119
|
+
end
|
120
|
+
# verify the required parameter 'org_id' is set
|
121
|
+
if @api_client.config.client_side_validation && org_id.nil?
|
122
|
+
fail ArgumentError, "Missing the required parameter 'org_id' when calling HardwareBaselineDashboardsApi.get_system_hardware_summary"
|
123
|
+
end
|
124
|
+
# resource path
|
125
|
+
local_var_path = '/api/dashboards/system-hardware-summary'
|
126
|
+
|
127
|
+
# query parameters
|
128
|
+
query_params = opts[:query_params] || {}
|
129
|
+
query_params[:'orgId'] = org_id
|
130
|
+
query_params[:'excludeinherited'] = opts[:'excludeinherited'] if !opts[:'excludeinherited'].nil?
|
131
|
+
query_params[:'pageIndex'] = opts[:'page_index'] if !opts[:'page_index'].nil?
|
132
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
133
|
+
|
134
|
+
# header parameters
|
135
|
+
header_params = opts[:header_params] || {}
|
136
|
+
# HTTP header 'Accept' (if needed)
|
137
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
138
|
+
|
139
|
+
# form parameters
|
140
|
+
form_params = opts[:form_params] || {}
|
141
|
+
|
142
|
+
# http body (model)
|
143
|
+
post_body = opts[:debug_body]
|
144
|
+
|
145
|
+
# return_type
|
146
|
+
return_type = opts[:debug_return_type] || 'Object'
|
147
|
+
|
148
|
+
# auth_names
|
149
|
+
auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
|
150
|
+
|
151
|
+
new_options = opts.merge(
|
152
|
+
:operation => :"HardwareBaselineDashboardsApi.get_system_hardware_summary",
|
153
|
+
:header_params => header_params,
|
154
|
+
:query_params => query_params,
|
155
|
+
:form_params => form_params,
|
156
|
+
:body => post_body,
|
157
|
+
:auth_names => auth_names,
|
158
|
+
:return_type => return_type
|
159
|
+
)
|
160
|
+
|
161
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
162
|
+
if @api_client.config.debugging
|
163
|
+
@api_client.config.logger.debug "API called: HardwareBaselineDashboardsApi#get_system_hardware_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
164
|
+
end
|
165
|
+
return data, status_code, headers
|
166
|
+
end
|
167
|
+
end
|
168
|
+
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
|
|
@@ -105,7 +105,7 @@ module EmassClient
|
|
105
105
|
# @param poam_id [Integer] **POA&M Id**: The unique POA&M record identifier.
|
106
106
|
# @param milestones_request_delete_body_inner [Array<MilestonesRequestDeleteBodyInner>] Delete the given Milestone Id
|
107
107
|
# @param [Hash] opts the optional parameters
|
108
|
-
# @return [
|
108
|
+
# @return [MilestoneResponseDelete]
|
109
109
|
def delete_milestone(system_id, poam_id, milestones_request_delete_body_inner, opts = {})
|
110
110
|
data, _status_code, _headers = delete_milestone_with_http_info(system_id, poam_id, milestones_request_delete_body_inner, opts)
|
111
111
|
data
|
@@ -117,7 +117,7 @@ module EmassClient
|
|
117
117
|
# @param poam_id [Integer] **POA&M Id**: The unique POA&M record identifier.
|
118
118
|
# @param milestones_request_delete_body_inner [Array<MilestonesRequestDeleteBodyInner>] Delete the given Milestone Id
|
119
119
|
# @param [Hash] opts the optional parameters
|
120
|
-
# @return [Array<(
|
120
|
+
# @return [Array<(MilestoneResponseDelete, Integer, Hash)>] MilestoneResponseDelete data, response status code and response headers
|
121
121
|
def delete_milestone_with_http_info(system_id, poam_id, milestones_request_delete_body_inner, opts = {})
|
122
122
|
if @api_client.config.debugging
|
123
123
|
@api_client.config.logger.debug 'Calling API: MilestonesApi.delete_milestone ...'
|
@@ -157,7 +157,7 @@ module EmassClient
|
|
157
157
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(milestones_request_delete_body_inner)
|
158
158
|
|
159
159
|
# return_type
|
160
|
-
return_type = opts[:debug_return_type] || '
|
160
|
+
return_type = opts[:debug_return_type] || 'MilestoneResponseDelete'
|
161
161
|
|
162
162
|
# auth_names
|
163
163
|
auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
|
@@ -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
|
|
@@ -19,8 +19,8 @@ module EmassClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
# Adds a Package Approval Chain (PAC) for given `systemId` path parameter
|
22
|
+
# Initiate system workflow for review
|
23
|
+
# Adds a Package Approval Chain (PAC) for given `systemId` path parameter **Request Body Required Fields** - `workflow` - `name` - `comments`
|
24
24
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
25
25
|
# @param request_body [Array<Object>] Add system package to PAC for review
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -30,8 +30,8 @@ module EmassClient
|
|
30
30
|
data
|
31
31
|
end
|
32
32
|
|
33
|
-
#
|
34
|
-
# Adds a Package Approval Chain (PAC) for given `systemId` path parameter
|
33
|
+
# Initiate system workflow for review
|
34
|
+
# Adds a Package Approval Chain (PAC) for given `systemId` path parameter **Request Body Required Fields** - `workflow` - `name` - `comments`
|
35
35
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
36
36
|
# @param request_body [Array<Object>] Add system package to PAC for review
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -93,8 +93,8 @@ module EmassClient
|
|
93
93
|
return data, status_code, headers
|
94
94
|
end
|
95
95
|
|
96
|
-
# Get
|
97
|
-
# Returns the location of a system's package in the Package Approval Chain (PAC) for matching `systemId` path parameter
|
96
|
+
# Get status of active workflows in a system
|
97
|
+
# Returns the location of a system's package in the Package Approval Chain (PAC) for matching `systemId` path parameter **Notes:** - If the indicated system has any active workflows, the response will include information such as the workflow type and the current stage of each workflow. - If there are no active workflows, then a null data member will be returned.
|
98
98
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
99
99
|
# @param [Hash] opts the optional parameters
|
100
100
|
# @return [PacResponseGet]
|
@@ -103,8 +103,8 @@ module EmassClient
|
|
103
103
|
data
|
104
104
|
end
|
105
105
|
|
106
|
-
# Get
|
107
|
-
# Returns the location of a system's package in the Package Approval Chain (PAC) for matching `systemId` path parameter
|
106
|
+
# Get status of active workflows in a system
|
107
|
+
# Returns the location of a system's package in the Package Approval Chain (PAC) for matching `systemId` path parameter **Notes:** - If the indicated system has any active workflows, the response will include information such as the workflow type and the current stage of each workflow. - If there are no active workflows, then a null data member will be returned.
|
108
108
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
109
109
|
# @param [Hash] opts the optional parameters
|
110
110
|
# @return [Array<(PacResponseGet, Integer, Hash)>] PacResponseGet data, response status code and response headers
|
@@ -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
|
|
@@ -173,8 +173,9 @@ module EmassClient
|
|
173
173
|
# @param [Hash] opts the optional parameters
|
174
174
|
# @option opts [String] :scheduled_completion_date_start **Date Started**: Filter query by the scheduled completion start date (Unix date format).
|
175
175
|
# @option opts [String] :scheduled_completion_date_end **Date Ended**: Filter query by the scheduled completion start date (Unix date format).
|
176
|
-
# @option opts [String] :control_acronyms **
|
177
|
-
# @option opts [String] :
|
176
|
+
# @option opts [String] :control_acronyms **Control Acronym**: Filter query by given system acronym (single value or comma separated).
|
177
|
+
# @option opts [String] :assessment_procedures **Assessment Procedure**: Filter query by given Security Control Assessment Procedure (single value or comma separated).
|
178
|
+
# @option opts [String] :ccis **CCI System**: Filter query by Control Correlation Identifiers (CCIs) (single value or comma separated).
|
178
179
|
# @option opts [Boolean] :system_only **Systems Only**: Indicates that only system(s) information is retrieved. (default to true)
|
179
180
|
# @return [PoamResponseGetSystems]
|
180
181
|
def get_system_poams(system_id, opts = {})
|
@@ -188,8 +189,9 @@ module EmassClient
|
|
188
189
|
# @param [Hash] opts the optional parameters
|
189
190
|
# @option opts [String] :scheduled_completion_date_start **Date Started**: Filter query by the scheduled completion start date (Unix date format).
|
190
191
|
# @option opts [String] :scheduled_completion_date_end **Date Ended**: Filter query by the scheduled completion start date (Unix date format).
|
191
|
-
# @option opts [String] :control_acronyms **
|
192
|
-
# @option opts [String] :
|
192
|
+
# @option opts [String] :control_acronyms **Control Acronym**: Filter query by given system acronym (single value or comma separated).
|
193
|
+
# @option opts [String] :assessment_procedures **Assessment Procedure**: Filter query by given Security Control Assessment Procedure (single value or comma separated).
|
194
|
+
# @option opts [String] :ccis **CCI System**: Filter query by Control Correlation Identifiers (CCIs) (single value or comma separated).
|
193
195
|
# @option opts [Boolean] :system_only **Systems Only**: Indicates that only system(s) information is retrieved. (default to true)
|
194
196
|
# @return [Array<(PoamResponseGetSystems, Integer, Hash)>] PoamResponseGetSystems data, response status code and response headers
|
195
197
|
def get_system_poams_with_http_info(system_id, opts = {})
|
@@ -208,6 +210,7 @@ module EmassClient
|
|
208
210
|
query_params[:'scheduledCompletionDateStart'] = opts[:'scheduled_completion_date_start'] if !opts[:'scheduled_completion_date_start'].nil?
|
209
211
|
query_params[:'scheduledCompletionDateEnd'] = opts[:'scheduled_completion_date_end'] if !opts[:'scheduled_completion_date_end'].nil?
|
210
212
|
query_params[:'controlAcronyms'] = opts[:'control_acronyms'] if !opts[:'control_acronyms'].nil?
|
213
|
+
query_params[:'assessmentProcedures'] = opts[:'assessment_procedures'] if !opts[:'assessment_procedures'].nil?
|
211
214
|
query_params[:'ccis'] = opts[:'ccis'] if !opts[:'ccis'].nil?
|
212
215
|
query_params[:'systemOnly'] = opts[:'system_only'] if !opts[:'system_only'].nil?
|
213
216
|
|
@@ -315,7 +318,7 @@ module EmassClient
|
|
315
318
|
end
|
316
319
|
|
317
320
|
# Update one or many POA&M items in a system
|
318
|
-
# Update a POA&M for given `systemId`<br> **Request Body Required Fields** - `poamId` - `displayPoamId` - `status` - `vulnerabilityDescription` - `sourceIdentVuln` - `pocOrganization` - `reviewStatus` **Notes** - If a POC email is supplied, the application will attempt to locate a user already registered within the application and pre-populate any information not explicitly supplied in the request. If no such user is found, these fields are **required** within the request.<br> `pocOrganization`, `pocFirstName`, `pocLastName`, `pocEmail`, `pocPhoneNumber`<br /> - To
|
321
|
+
# Update a POA&M for given `systemId`<br> **Request Body Required Fields** - `poamId` - `displayPoamId` - `status` - `vulnerabilityDescription` - `sourceIdentVuln` - `pocOrganization` - `reviewStatus` **Notes** - If a POC email is supplied, the application will attempt to locate a user already registered within the application and pre-populate any information not explicitly supplied in the request. If no such user is found, these fields are **required** within the request.<br> `pocOrganization`, `pocFirstName`, `pocLastName`, `pocEmail`, `pocPhoneNumber`<br /> - To prevent uploading duplicate/undesired milestones through the POA&M PUT we must include an `isActive` field for the milestone and set it to equal to false `(isActive=false)`.
|
319
322
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
320
323
|
# @param request_body [Array<Object>] Update an existing control by Id
|
321
324
|
# @param [Hash] opts the optional parameters
|
@@ -326,7 +329,7 @@ module EmassClient
|
|
326
329
|
end
|
327
330
|
|
328
331
|
# Update one or many POA&M items in a system
|
329
|
-
# Update a POA&M for given `systemId`<br> **Request Body Required Fields** - `poamId` - `displayPoamId` - `status` - `vulnerabilityDescription` - `sourceIdentVuln` - `pocOrganization` - `reviewStatus` **Notes** - If a POC email is supplied, the application will attempt to locate a user already registered within the application and pre-populate any information not explicitly supplied in the request. If no such user is found, these fields are **required** within the request.<br> `pocOrganization`, `pocFirstName`, `pocLastName`, `pocEmail`, `pocPhoneNumber`<br /> - To
|
332
|
+
# Update a POA&M for given `systemId`<br> **Request Body Required Fields** - `poamId` - `displayPoamId` - `status` - `vulnerabilityDescription` - `sourceIdentVuln` - `pocOrganization` - `reviewStatus` **Notes** - If a POC email is supplied, the application will attempt to locate a user already registered within the application and pre-populate any information not explicitly supplied in the request. If no such user is found, these fields are **required** within the request.<br> `pocOrganization`, `pocFirstName`, `pocLastName`, `pocEmail`, `pocPhoneNumber`<br /> - To prevent uploading duplicate/undesired milestones through the POA&M PUT we must include an `isActive` field for the milestone and set it to equal to false `(isActive=false)`.
|
330
333
|
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
331
334
|
# @param request_body [Array<Object>] Update an existing control by Id
|
332
335
|
# @param [Hash] opts the optional parameters
|
@@ -0,0 +1,168 @@
|
|
1
|
+
=begin
|
2
|
+
#Enterprise Mission Assurance Support Service (eMASS)
|
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` 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
|
+
|
6
|
+
The version of the OpenAPI document: v3.12
|
7
|
+
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 7.1.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module EmassClient
|
16
|
+
class PortsAndProtocolsDashboardsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# System Ports/Protocols Details
|
23
|
+
# Get system ports and protocols details dashboard information.
|
24
|
+
# @param org_id [Integer] **Organization Id**: The unique organization identifier.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [Boolean] :excludeinherited **Exclude Inherited**: If no value is specified, the default returns false to include inherited data. (default to false)
|
27
|
+
# @option opts [Integer] :page_index **Page Index**: If no value is specified, the default returns results from the first page with an index of 0. (default to 0)
|
28
|
+
# @option opts [Integer] :page_size **Page Size**: If no value is specified, the default returns 20000 per page. (default to 20000)
|
29
|
+
# @return [Object]
|
30
|
+
def get_system_ports_protocols_details(org_id, opts = {})
|
31
|
+
data, _status_code, _headers = get_system_ports_protocols_details_with_http_info(org_id, opts)
|
32
|
+
data
|
33
|
+
end
|
34
|
+
|
35
|
+
# System Ports/Protocols Details
|
36
|
+
# Get system ports and protocols details dashboard information.
|
37
|
+
# @param org_id [Integer] **Organization Id**: The unique organization identifier.
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @option opts [Boolean] :excludeinherited **Exclude Inherited**: If no value is specified, the default returns false to include inherited data. (default to false)
|
40
|
+
# @option opts [Integer] :page_index **Page Index**: If no value is specified, the default returns results from the first page with an index of 0. (default to 0)
|
41
|
+
# @option opts [Integer] :page_size **Page Size**: If no value is specified, the default returns 20000 per page. (default to 20000)
|
42
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
43
|
+
def get_system_ports_protocols_details_with_http_info(org_id, opts = {})
|
44
|
+
if @api_client.config.debugging
|
45
|
+
@api_client.config.logger.debug 'Calling API: PortsAndProtocolsDashboardsApi.get_system_ports_protocols_details ...'
|
46
|
+
end
|
47
|
+
# verify the required parameter 'org_id' is set
|
48
|
+
if @api_client.config.client_side_validation && org_id.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'org_id' when calling PortsAndProtocolsDashboardsApi.get_system_ports_protocols_details"
|
50
|
+
end
|
51
|
+
# resource path
|
52
|
+
local_var_path = '/api/dashboards/system-ports-protocols-details'
|
53
|
+
|
54
|
+
# query parameters
|
55
|
+
query_params = opts[:query_params] || {}
|
56
|
+
query_params[:'orgId'] = org_id
|
57
|
+
query_params[:'excludeinherited'] = opts[:'excludeinherited'] if !opts[:'excludeinherited'].nil?
|
58
|
+
query_params[:'pageIndex'] = opts[:'page_index'] if !opts[:'page_index'].nil?
|
59
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
60
|
+
|
61
|
+
# header parameters
|
62
|
+
header_params = opts[:header_params] || {}
|
63
|
+
# HTTP header 'Accept' (if needed)
|
64
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
65
|
+
|
66
|
+
# form parameters
|
67
|
+
form_params = opts[:form_params] || {}
|
68
|
+
|
69
|
+
# http body (model)
|
70
|
+
post_body = opts[:debug_body]
|
71
|
+
|
72
|
+
# return_type
|
73
|
+
return_type = opts[:debug_return_type] || 'Object'
|
74
|
+
|
75
|
+
# auth_names
|
76
|
+
auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
|
77
|
+
|
78
|
+
new_options = opts.merge(
|
79
|
+
:operation => :"PortsAndProtocolsDashboardsApi.get_system_ports_protocols_details",
|
80
|
+
:header_params => header_params,
|
81
|
+
:query_params => query_params,
|
82
|
+
:form_params => form_params,
|
83
|
+
:body => post_body,
|
84
|
+
:auth_names => auth_names,
|
85
|
+
:return_type => return_type
|
86
|
+
)
|
87
|
+
|
88
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
89
|
+
if @api_client.config.debugging
|
90
|
+
@api_client.config.logger.debug "API called: PortsAndProtocolsDashboardsApi#get_system_ports_protocols_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
91
|
+
end
|
92
|
+
return data, status_code, headers
|
93
|
+
end
|
94
|
+
|
95
|
+
# System Ports/Protocols Summary
|
96
|
+
# Get system ports and protocols summary dashboard information.
|
97
|
+
# @param org_id [Integer] **Organization Id**: The unique organization identifier.
|
98
|
+
# @param [Hash] opts the optional parameters
|
99
|
+
# @option opts [Boolean] :excludeinherited **Exclude Inherited**: If no value is specified, the default returns false to include inherited data. (default to false)
|
100
|
+
# @option opts [Integer] :page_index **Page Index**: If no value is specified, the default returns results from the first page with an index of 0. (default to 0)
|
101
|
+
# @option opts [Integer] :page_size **Page Size**: If no value is specified, the default returns 20000 per page. (default to 20000)
|
102
|
+
# @return [Object]
|
103
|
+
def get_system_ports_protocols_summary(org_id, opts = {})
|
104
|
+
data, _status_code, _headers = get_system_ports_protocols_summary_with_http_info(org_id, opts)
|
105
|
+
data
|
106
|
+
end
|
107
|
+
|
108
|
+
# System Ports/Protocols Summary
|
109
|
+
# Get system ports and protocols summary dashboard information.
|
110
|
+
# @param org_id [Integer] **Organization Id**: The unique organization identifier.
|
111
|
+
# @param [Hash] opts the optional parameters
|
112
|
+
# @option opts [Boolean] :excludeinherited **Exclude Inherited**: If no value is specified, the default returns false to include inherited data. (default to false)
|
113
|
+
# @option opts [Integer] :page_index **Page Index**: If no value is specified, the default returns results from the first page with an index of 0. (default to 0)
|
114
|
+
# @option opts [Integer] :page_size **Page Size**: If no value is specified, the default returns 20000 per page. (default to 20000)
|
115
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
116
|
+
def get_system_ports_protocols_summary_with_http_info(org_id, opts = {})
|
117
|
+
if @api_client.config.debugging
|
118
|
+
@api_client.config.logger.debug 'Calling API: PortsAndProtocolsDashboardsApi.get_system_ports_protocols_summary ...'
|
119
|
+
end
|
120
|
+
# verify the required parameter 'org_id' is set
|
121
|
+
if @api_client.config.client_side_validation && org_id.nil?
|
122
|
+
fail ArgumentError, "Missing the required parameter 'org_id' when calling PortsAndProtocolsDashboardsApi.get_system_ports_protocols_summary"
|
123
|
+
end
|
124
|
+
# resource path
|
125
|
+
local_var_path = '/api/dashboards/system-ports-protocols-summary'
|
126
|
+
|
127
|
+
# query parameters
|
128
|
+
query_params = opts[:query_params] || {}
|
129
|
+
query_params[:'orgId'] = org_id
|
130
|
+
query_params[:'excludeinherited'] = opts[:'excludeinherited'] if !opts[:'excludeinherited'].nil?
|
131
|
+
query_params[:'pageIndex'] = opts[:'page_index'] if !opts[:'page_index'].nil?
|
132
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
133
|
+
|
134
|
+
# header parameters
|
135
|
+
header_params = opts[:header_params] || {}
|
136
|
+
# HTTP header 'Accept' (if needed)
|
137
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
138
|
+
|
139
|
+
# form parameters
|
140
|
+
form_params = opts[:form_params] || {}
|
141
|
+
|
142
|
+
# http body (model)
|
143
|
+
post_body = opts[:debug_body]
|
144
|
+
|
145
|
+
# return_type
|
146
|
+
return_type = opts[:debug_return_type] || 'Object'
|
147
|
+
|
148
|
+
# auth_names
|
149
|
+
auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
|
150
|
+
|
151
|
+
new_options = opts.merge(
|
152
|
+
:operation => :"PortsAndProtocolsDashboardsApi.get_system_ports_protocols_summary",
|
153
|
+
:header_params => header_params,
|
154
|
+
:query_params => query_params,
|
155
|
+
:form_params => form_params,
|
156
|
+
:body => post_body,
|
157
|
+
:auth_names => auth_names,
|
158
|
+
:return_type => return_type
|
159
|
+
)
|
160
|
+
|
161
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
162
|
+
if @api_client.config.debugging
|
163
|
+
@api_client.config.logger.debug "API called: PortsAndProtocolsDashboardsApi#get_system_ports_protocols_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
164
|
+
end
|
165
|
+
return data, status_code, headers
|
166
|
+
end
|
167
|
+
end
|
168
|
+
end
|