emass_client 1.0.1 → 1.0.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +152 -1124
- data/Rakefile +2 -0
- data/lib/emass_client/api/artifacts_api.rb +124 -97
- data/lib/emass_client/api/artifacts_export_api.rb +28 -19
- data/lib/emass_client/api/cac_api.rb +50 -31
- data/lib/emass_client/api/cloud_resources_api.rb +96 -0
- data/lib/emass_client/api/cmmc_assessments_api.rb +20 -11
- data/lib/emass_client/api/containers_api.rb +96 -0
- data/lib/emass_client/api/controls_api.rb +53 -34
- data/lib/emass_client/api/milestones_api.rb +138 -92
- data/lib/emass_client/api/pac_api.rb +50 -31
- data/lib/emass_client/api/poam_api.rb +132 -86
- data/lib/emass_client/api/registration_api.rb +30 -18
- data/lib/emass_client/api/static_code_scans_api.rb +38 -26
- data/lib/emass_client/api/system_roles_api.rb +48 -29
- data/lib/emass_client/api/systems_api.rb +57 -39
- data/lib/emass_client/api/test_api.rb +20 -11
- data/lib/emass_client/api/test_results_api.rb +53 -34
- data/lib/emass_client/api/workflow_definitions_api.rb +23 -14
- data/lib/emass_client/api/workflow_instances_api.rb +58 -53
- data/lib/emass_client/api_client.rb +59 -57
- data/lib/emass_client/api_error.rb +5 -5
- data/lib/emass_client/configuration.rb +93 -16
- data/lib/emass_client/models/artifacts_get.rb +54 -31
- data/lib/emass_client/models/{artifacts_delete_inner.rb → artifacts_request_delete_body_inner.rb} +29 -16
- data/lib/emass_client/models/artifacts_response_del.rb +27 -14
- data/lib/emass_client/models/{artifacts_response_del_data.rb → artifacts_response_del_data_inner.rb} +31 -18
- data/lib/emass_client/models/artifacts_response_get.rb +27 -14
- data/lib/emass_client/models/artifacts_response_put_post.rb +27 -14
- data/lib/emass_client/models/artifacts_response_put_post_data_inner.rb +265 -0
- data/lib/emass_client/models/cac_get.rb +82 -50
- data/lib/emass_client/models/cac_response_get.rb +27 -14
- data/lib/emass_client/models/cac_response_post.rb +27 -14
- data/lib/emass_client/models/{cac_response_post_data.rb → cac_response_post_data_inner.rb} +61 -21
- data/lib/emass_client/models/{pac_request_post_body.rb → cloud_resources_post.rb} +73 -69
- data/lib/emass_client/models/cloud_resources_response_post.rb +230 -0
- data/lib/emass_client/models/cmmc_get.rb +53 -63
- data/lib/emass_client/models/cmmc_response_get.rb +27 -14
- data/lib/emass_client/models/connectivity_ccsd.rb +29 -14
- data/lib/emass_client/models/containers_resources_post.rb +265 -0
- data/lib/emass_client/models/containers_response_post.rb +230 -0
- data/lib/emass_client/models/controls_get.rb +103 -66
- data/lib/emass_client/models/controls_put.rb +58 -18
- data/lib/emass_client/models/controls_response_get.rb +28 -14
- data/lib/emass_client/models/controls_response_put.rb +27 -14
- data/lib/emass_client/models/definition_transitions.rb +32 -62
- data/lib/emass_client/models/instances_transitions.rb +37 -88
- data/lib/emass_client/models/milestone_response_get.rb +27 -14
- data/lib/emass_client/models/milestone_response_get_milestone.rb +228 -0
- data/lib/emass_client/models/milestone_response_post.rb +27 -14
- data/lib/emass_client/models/milestone_response_put.rb +27 -14
- data/lib/emass_client/models/milestones_get.rb +33 -20
- data/lib/emass_client/models/milestones_put_post_delete.rb +60 -20
- data/lib/emass_client/models/{delete_milestone.rb → milestones_request_delete_body_inner.rb} +29 -21
- data/lib/emass_client/models/milestones_required_post.rb +27 -14
- data/lib/emass_client/models/milestones_required_put.rb +28 -15
- data/lib/emass_client/models/pac_get.rb +39 -22
- data/lib/emass_client/models/pac_post.rb +60 -20
- data/lib/emass_client/models/pac_response_get.rb +28 -14
- data/lib/emass_client/models/pac_response_post.rb +27 -14
- data/lib/emass_client/models/poam_get.rb +114 -77
- data/lib/emass_client/models/poam_post_put_del.rb +59 -19
- data/lib/emass_client/models/{delete_poam.rb → poam_request_delete_body_inner.rb} +29 -21
- data/lib/emass_client/models/poam_response_delete.rb +27 -14
- data/lib/emass_client/models/poam_response_get_poams.rb +228 -0
- data/lib/emass_client/models/{static_code_required_post.rb → poam_response_get_systems.rb} +42 -29
- data/lib/emass_client/models/poam_response_post.rb +27 -14
- data/lib/emass_client/models/poam_response_put.rb +27 -14
- data/lib/emass_client/models/register.rb +27 -14
- data/lib/emass_client/models/register_data.rb +26 -13
- data/lib/emass_client/models/register_user_request_post_body.rb +26 -13
- data/lib/emass_client/models/{model_200.rb → response200.rb} +53 -16
- data/lib/emass_client/models/{model_400.rb → response201.rb} +29 -16
- data/lib/emass_client/models/{model_201_meta.rb → response201_meta.rb} +54 -17
- data/lib/emass_client/models/{model_400_response.rb → response400.rb} +29 -16
- data/lib/emass_client/models/{model_400_meta.rb → response400_meta.rb} +54 -17
- data/lib/emass_client/models/{model_401.rb → response401.rb} +29 -16
- data/lib/emass_client/models/{model_401_meta.rb → response401_meta.rb} +54 -17
- data/lib/emass_client/models/{model_201.rb → response403.rb} +29 -16
- data/lib/emass_client/models/{model_403_meta.rb → response403_meta.rb} +54 -17
- data/lib/emass_client/models/{model_404.rb → response404.rb} +54 -17
- data/lib/emass_client/models/response405.rb +219 -0
- data/lib/emass_client/models/{model_405_meta.rb → response405_meta.rb} +54 -17
- data/lib/emass_client/models/response411.rb +219 -0
- data/lib/emass_client/models/{model_411_meta.rb → response411_meta.rb} +54 -17
- data/lib/emass_client/models/response490.rb +219 -0
- data/lib/emass_client/models/{model_490_meta.rb → response490_meta.rb} +54 -17
- data/lib/emass_client/models/response500.rb +219 -0
- data/lib/emass_client/models/{model_500_meta.rb → response500_meta.rb} +54 -17
- data/lib/emass_client/models/role_category.rb +32 -50
- data/lib/emass_client/models/roles.rb +29 -61
- data/lib/emass_client/models/ssps.rb +32 -16
- data/lib/emass_client/models/stage.rb +30 -49
- data/lib/emass_client/models/static_code_application.rb +34 -33
- data/lib/emass_client/models/static_code_post.rb +275 -0
- data/lib/emass_client/models/static_code_request_post_body.rb +47 -14
- data/lib/emass_client/models/{static_code_required_post_application.rb → static_code_request_post_body_application.rb} +30 -17
- data/lib/emass_client/models/static_code_response_post.rb +230 -0
- data/lib/emass_client/models/success200_response.rb +27 -14
- data/lib/emass_client/models/{error.rb → success200_response_data_inner.rb} +57 -36
- data/lib/emass_client/models/system_response.rb +28 -17
- data/lib/emass_client/models/system_roles_category_response.rb +28 -14
- data/lib/emass_client/models/system_roles_response.rb +27 -14
- data/lib/emass_client/models/{system_roles_response_data.rb → system_roles_response_data_inner.rb} +30 -17
- data/lib/emass_client/models/systems.rb +218 -191
- data/lib/emass_client/models/{poam_response_get.rb → systems_response.rb} +30 -17
- data/lib/emass_client/models/test.rb +27 -14
- data/lib/emass_client/models/test_data.rb +26 -13
- data/lib/emass_client/models/test_results_get.rb +39 -35
- data/lib/emass_client/models/test_results_post.rb +58 -18
- data/lib/emass_client/models/test_results_response_get.rb +27 -14
- data/lib/emass_client/models/test_results_response_post.rb +27 -14
- data/lib/emass_client/models/users.rb +28 -15
- data/lib/emass_client/models/workflow_definition_get.rb +63 -68
- data/lib/emass_client/models/workflow_definition_response_get.rb +27 -14
- data/lib/emass_client/models/workflow_instance_get.rb +331 -0
- data/lib/emass_client/models/workflow_instance_response_get.rb +230 -0
- data/lib/emass_client/models/workflow_instances_get.rb +107 -133
- data/lib/emass_client/models/workflow_instances_response_get.rb +39 -17
- data/lib/emass_client/models/workflow_instances_response_get_pagination.rb +246 -0
- data/lib/emass_client/version.rb +6 -5
- data/lib/emass_client.rb +47 -54
- metadata +60 -89
- data/lib/emass_client/models/artifacts_delete.rb +0 -201
- data/lib/emass_client/models/artifacts_request_put_body.rb +0 -363
- data/lib/emass_client/models/cac_request_post_body.rb +0 -217
- data/lib/emass_client/models/controls_request_put_body.rb +0 -606
- data/lib/emass_client/models/empty200_response.rb +0 -197
- data/lib/emass_client/models/milestones_delete.rb +0 -197
- data/lib/emass_client/models/milestones_post.rb +0 -197
- data/lib/emass_client/models/milestones_put.rb +0 -197
- data/lib/emass_client/models/milestones_request_post_body.rb +0 -242
- data/lib/emass_client/models/milestones_request_put_body.rb +0 -242
- data/lib/emass_client/models/model_403.rb +0 -206
- data/lib/emass_client/models/model_404_response.rb +0 -206
- data/lib/emass_client/models/model_405.rb +0 -206
- data/lib/emass_client/models/model_411.rb +0 -206
- data/lib/emass_client/models/model_490.rb +0 -206
- data/lib/emass_client/models/model_500.rb +0 -206
- data/lib/emass_client/models/poam_delete.rb +0 -197
- data/lib/emass_client/models/poam_post.rb +0 -197
- data/lib/emass_client/models/poam_put.rb +0 -197
- data/lib/emass_client/models/poam_request_post_body.rb +0 -197
- data/lib/emass_client/models/poam_request_put_body.rb +0 -197
- data/lib/emass_client/models/poam_required_post.rb +0 -564
- data/lib/emass_client/models/poam_required_put.rb +0 -594
- data/lib/emass_client/models/system_id_artifacts_body.rb +0 -284
- data/lib/emass_client/models/test_results_request_post_body.rb +0 -306
@@ -1,14 +1,17 @@
|
|
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.
|
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.</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
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: v3.3
|
7
7
|
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
10
|
+
|
10
11
|
=end
|
11
12
|
|
13
|
+
require 'cgi'
|
14
|
+
|
12
15
|
module EmassClient
|
13
16
|
class RegistrationApi
|
14
17
|
attr_accessor :api_client
|
@@ -18,26 +21,26 @@ module EmassClient
|
|
18
21
|
end
|
19
22
|
# Register user certificate and obtain an API key
|
20
23
|
# Returns the api-key - This API key must be provided in the request header for all endpoint calls (api-key).
|
21
|
-
# @param
|
24
|
+
# @param register_user_request_post_body [RegisterUserRequestPostBody] Register certificate provided by eMASS.
|
22
25
|
# @param [Hash] opts the optional parameters
|
23
26
|
# @return [Register]
|
24
|
-
def register_user(
|
25
|
-
data, _status_code, _headers = register_user_with_http_info(
|
27
|
+
def register_user(register_user_request_post_body, opts = {})
|
28
|
+
data, _status_code, _headers = register_user_with_http_info(register_user_request_post_body, opts)
|
26
29
|
data
|
27
30
|
end
|
28
31
|
|
29
32
|
# Register user certificate and obtain an API key
|
30
33
|
# Returns the api-key - This API key must be provided in the request header for all endpoint calls (api-key).
|
31
|
-
# @param
|
34
|
+
# @param register_user_request_post_body [RegisterUserRequestPostBody] Register certificate provided by eMASS.
|
32
35
|
# @param [Hash] opts the optional parameters
|
33
36
|
# @return [Array<(Register, Integer, Hash)>] Register data, response status code and response headers
|
34
|
-
def register_user_with_http_info(
|
37
|
+
def register_user_with_http_info(register_user_request_post_body, opts = {})
|
35
38
|
if @api_client.config.debugging
|
36
39
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.register_user ...'
|
37
40
|
end
|
38
|
-
# verify the required parameter '
|
39
|
-
if @api_client.config.client_side_validation &&
|
40
|
-
fail ArgumentError, "Missing the required parameter '
|
41
|
+
# verify the required parameter 'register_user_request_post_body' is set
|
42
|
+
if @api_client.config.client_side_validation && register_user_request_post_body.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'register_user_request_post_body' when calling RegistrationApi.register_user"
|
41
44
|
end
|
42
45
|
# resource path
|
43
46
|
local_var_path = '/api/api-key'
|
@@ -50,25 +53,34 @@ module EmassClient
|
|
50
53
|
# HTTP header 'Accept' (if needed)
|
51
54
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
52
55
|
# HTTP header 'Content-Type'
|
53
|
-
|
56
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
57
|
+
if !content_type.nil?
|
58
|
+
header_params['Content-Type'] = content_type
|
59
|
+
end
|
54
60
|
|
55
61
|
# form parameters
|
56
62
|
form_params = opts[:form_params] || {}
|
57
63
|
|
58
64
|
# http body (model)
|
59
|
-
post_body = opts[:
|
65
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(register_user_request_post_body)
|
66
|
+
|
67
|
+
# return_type
|
68
|
+
return_type = opts[:debug_return_type] || 'Register'
|
60
69
|
|
61
|
-
|
70
|
+
# auth_names
|
71
|
+
auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
|
62
72
|
|
63
|
-
|
64
|
-
|
73
|
+
new_options = opts.merge(
|
74
|
+
:operation => :"RegistrationApi.register_user",
|
65
75
|
:header_params => header_params,
|
66
76
|
:query_params => query_params,
|
67
77
|
:form_params => form_params,
|
68
78
|
:body => post_body,
|
69
79
|
:auth_names => auth_names,
|
70
|
-
:return_type => return_type
|
80
|
+
:return_type => return_type
|
81
|
+
)
|
71
82
|
|
83
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
72
84
|
if @api_client.config.debugging
|
73
85
|
@api_client.config.logger.debug "API called: RegistrationApi#register_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
74
86
|
end
|
@@ -1,14 +1,17 @@
|
|
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.
|
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.</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
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: v3.3
|
7
7
|
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
10
|
+
|
10
11
|
=end
|
11
12
|
|
13
|
+
require 'cgi'
|
14
|
+
|
12
15
|
module EmassClient
|
13
16
|
class StaticCodeScansApi
|
14
17
|
attr_accessor :api_client
|
@@ -17,36 +20,36 @@ module EmassClient
|
|
17
20
|
@api_client = api_client
|
18
21
|
end
|
19
22
|
# Upload static code scans or Clear static code scans
|
20
|
-
# Upload or clear application scan findings into a system's `systemId` assets module. **Note:** To clear an application's findings, use only the field `clearFindings` as the Request body and set it to true.
|
21
|
-
# @param
|
22
|
-
# @param
|
23
|
+
# Upload or clear application scan findings into a system's `systemId` assets module. **Note:** To clear an application's findings, use only the field `clearFindings` as the Request body and set it to true. Example: ``` [ { \"application\": { \"applicationName\": \"Artemis\", \"version\": \"Version 5.0\" }, \"applicationFindings\": [ { \"clearFindings\": true } ] } ] ```
|
24
|
+
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
25
|
+
# @param static_code_request_post_body [StaticCodeRequestPostBody] Add static code scans or Clear static code scans
|
23
26
|
# @param [Hash] opts the optional parameters
|
24
|
-
# @return [
|
25
|
-
def add_static_code_scans_by_system_id(
|
26
|
-
data, _status_code, _headers = add_static_code_scans_by_system_id_with_http_info(
|
27
|
+
# @return [StaticCodeResponsePost]
|
28
|
+
def add_static_code_scans_by_system_id(system_id, static_code_request_post_body, opts = {})
|
29
|
+
data, _status_code, _headers = add_static_code_scans_by_system_id_with_http_info(system_id, static_code_request_post_body, opts)
|
27
30
|
data
|
28
31
|
end
|
29
32
|
|
30
33
|
# Upload static code scans or Clear static code scans
|
31
|
-
# Upload or clear application scan findings into a system&#
|
32
|
-
# @param
|
33
|
-
# @param
|
34
|
+
# Upload or clear application scan findings into a system's `systemId` assets module. **Note:** To clear an application's findings, use only the field `clearFindings` as the Request body and set it to true. Example: ``` [ { \"application\": { \"applicationName\": \"Artemis\", \"version\": \"Version 5.0\" }, \"applicationFindings\": [ { \"clearFindings\": true } ] } ] ```
|
35
|
+
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
36
|
+
# @param static_code_request_post_body [StaticCodeRequestPostBody] Add static code scans or Clear static code scans
|
34
37
|
# @param [Hash] opts the optional parameters
|
35
|
-
# @return [Array<(
|
36
|
-
def add_static_code_scans_by_system_id_with_http_info(
|
38
|
+
# @return [Array<(StaticCodeResponsePost, Integer, Hash)>] StaticCodeResponsePost data, response status code and response headers
|
39
|
+
def add_static_code_scans_by_system_id_with_http_info(system_id, static_code_request_post_body, opts = {})
|
37
40
|
if @api_client.config.debugging
|
38
41
|
@api_client.config.logger.debug 'Calling API: StaticCodeScansApi.add_static_code_scans_by_system_id ...'
|
39
42
|
end
|
40
|
-
# verify the required parameter 'body' is set
|
41
|
-
if @api_client.config.client_side_validation && body.nil?
|
42
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling StaticCodeScansApi.add_static_code_scans_by_system_id"
|
43
|
-
end
|
44
43
|
# verify the required parameter 'system_id' is set
|
45
44
|
if @api_client.config.client_side_validation && system_id.nil?
|
46
45
|
fail ArgumentError, "Missing the required parameter 'system_id' when calling StaticCodeScansApi.add_static_code_scans_by_system_id"
|
47
46
|
end
|
47
|
+
# verify the required parameter 'static_code_request_post_body' is set
|
48
|
+
if @api_client.config.client_side_validation && static_code_request_post_body.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'static_code_request_post_body' when calling StaticCodeScansApi.add_static_code_scans_by_system_id"
|
50
|
+
end
|
48
51
|
# resource path
|
49
|
-
local_var_path = '/api/systems/{systemId}/static-code-scans'.sub('{' + 'systemId' + '}', system_id.to_s)
|
52
|
+
local_var_path = '/api/systems/{systemId}/static-code-scans'.sub('{' + 'systemId' + '}', CGI.escape(system_id.to_s))
|
50
53
|
|
51
54
|
# query parameters
|
52
55
|
query_params = opts[:query_params] || {}
|
@@ -56,25 +59,34 @@ module EmassClient
|
|
56
59
|
# HTTP header 'Accept' (if needed)
|
57
60
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
58
61
|
# HTTP header 'Content-Type'
|
59
|
-
|
62
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
63
|
+
if !content_type.nil?
|
64
|
+
header_params['Content-Type'] = content_type
|
65
|
+
end
|
60
66
|
|
61
67
|
# form parameters
|
62
68
|
form_params = opts[:form_params] || {}
|
63
69
|
|
64
70
|
# http body (model)
|
65
|
-
post_body = opts[:
|
71
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(static_code_request_post_body)
|
72
|
+
|
73
|
+
# return_type
|
74
|
+
return_type = opts[:debug_return_type] || 'StaticCodeResponsePost'
|
66
75
|
|
67
|
-
|
76
|
+
# auth_names
|
77
|
+
auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
|
68
78
|
|
69
|
-
|
70
|
-
|
79
|
+
new_options = opts.merge(
|
80
|
+
:operation => :"StaticCodeScansApi.add_static_code_scans_by_system_id",
|
71
81
|
:header_params => header_params,
|
72
82
|
:query_params => query_params,
|
73
83
|
:form_params => form_params,
|
74
84
|
:body => post_body,
|
75
85
|
:auth_names => auth_names,
|
76
|
-
:return_type => return_type
|
86
|
+
:return_type => return_type
|
87
|
+
)
|
77
88
|
|
89
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
78
90
|
if @api_client.config.debugging
|
79
91
|
@api_client.config.logger.debug "API called: StaticCodeScansApi#add_static_code_scans_by_system_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
80
92
|
end
|
@@ -1,14 +1,17 @@
|
|
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.
|
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.</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
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: v3.3
|
7
7
|
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
10
|
+
|
10
11
|
=end
|
11
12
|
|
13
|
+
require 'cgi'
|
14
|
+
|
12
15
|
module EmassClient
|
13
16
|
class SystemRolesApi
|
14
17
|
attr_accessor :api_client
|
@@ -48,31 +51,38 @@ module EmassClient
|
|
48
51
|
form_params = opts[:form_params] || {}
|
49
52
|
|
50
53
|
# http body (model)
|
51
|
-
post_body = opts[:
|
54
|
+
post_body = opts[:debug_body]
|
55
|
+
|
56
|
+
# return_type
|
57
|
+
return_type = opts[:debug_return_type] || 'SystemRolesResponse'
|
52
58
|
|
53
|
-
|
59
|
+
# auth_names
|
60
|
+
auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
|
54
61
|
|
55
|
-
|
56
|
-
|
62
|
+
new_options = opts.merge(
|
63
|
+
:operation => :"SystemRolesApi.get_system_roles",
|
57
64
|
:header_params => header_params,
|
58
65
|
:query_params => query_params,
|
59
66
|
:form_params => form_params,
|
60
67
|
:body => post_body,
|
61
68
|
:auth_names => auth_names,
|
62
|
-
:return_type => return_type
|
69
|
+
:return_type => return_type
|
70
|
+
)
|
63
71
|
|
72
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
64
73
|
if @api_client.config.debugging
|
65
74
|
@api_client.config.logger.debug "API called: SystemRolesApi#get_system_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
66
75
|
end
|
67
76
|
return data, status_code, headers
|
68
77
|
end
|
78
|
+
|
69
79
|
# Get system roles
|
70
80
|
# Returns the role(s) data matching parameters.
|
71
|
-
# @param role_category **Role Category**: The system role category been queried
|
72
|
-
# @param role **Role**: Accepts single value from options available at base system-roles endpoint e.g., SCA.
|
81
|
+
# @param role_category [String] **Role Category**: The system role category been queried
|
82
|
+
# @param role [String] **Role**: Accepts single value from options available at base system-roles endpoint e.g., SCA.
|
73
83
|
# @param [Hash] opts the optional parameters
|
74
|
-
# @option opts [String] :policy **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information. (default to rmf)
|
75
|
-
# @option opts [
|
84
|
+
# @option opts [String] :policy **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information. (default to 'rmf')
|
85
|
+
# @option opts [Boolean] :include_decommissioned **Include Decommissioned Systems**: Indicates if decommissioned systems are retrieved. If no value is specified, the default returns true to include decommissioned systems. (default to true)
|
76
86
|
# @return [SystemRolesCategoryResponse]
|
77
87
|
def get_system_roles_by_category_id(role_category, role, opts = {})
|
78
88
|
data, _status_code, _headers = get_system_roles_by_category_id_with_http_info(role_category, role, opts)
|
@@ -81,11 +91,11 @@ module EmassClient
|
|
81
91
|
|
82
92
|
# Get system roles
|
83
93
|
# Returns the role(s) data matching parameters.
|
84
|
-
# @param role_category **Role Category**: The system role category been queried
|
85
|
-
# @param role **Role**: Accepts single value from options available at base system-roles endpoint e.g., SCA.
|
94
|
+
# @param role_category [String] **Role Category**: The system role category been queried
|
95
|
+
# @param role [String] **Role**: Accepts single value from options available at base system-roles endpoint e.g., SCA.
|
86
96
|
# @param [Hash] opts the optional parameters
|
87
|
-
# @option opts [String] :policy **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information.
|
88
|
-
# @option opts [
|
97
|
+
# @option opts [String] :policy **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information. (default to 'rmf')
|
98
|
+
# @option opts [Boolean] :include_decommissioned **Include Decommissioned Systems**: Indicates if decommissioned systems are retrieved. If no value is specified, the default returns true to include decommissioned systems. (default to true)
|
89
99
|
# @return [Array<(SystemRolesCategoryResponse, Integer, Hash)>] SystemRolesCategoryResponse data, response status code and response headers
|
90
100
|
def get_system_roles_by_category_id_with_http_info(role_category, role, opts = {})
|
91
101
|
if @api_client.config.debugging
|
@@ -96,22 +106,25 @@ module EmassClient
|
|
96
106
|
fail ArgumentError, "Missing the required parameter 'role_category' when calling SystemRolesApi.get_system_roles_by_category_id"
|
97
107
|
end
|
98
108
|
# verify enum value
|
99
|
-
|
100
|
-
|
109
|
+
allowable_values = ["CAC", "PAC", "Other", "unknown_default_open_api"]
|
110
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(role_category)
|
111
|
+
fail ArgumentError, "invalid value for \"role_category\", must be one of #{allowable_values}"
|
101
112
|
end
|
102
113
|
# verify the required parameter 'role' is set
|
103
114
|
if @api_client.config.client_side_validation && role.nil?
|
104
115
|
fail ArgumentError, "Missing the required parameter 'role' when calling SystemRolesApi.get_system_roles_by_category_id"
|
105
116
|
end
|
106
117
|
# verify enum value
|
107
|
-
|
108
|
-
|
118
|
+
allowable_values = ["AO", "Auditor", "Artifact Manager", "C&A Team", "IAO", "ISSO", "PM/IAM", "SCA", "User Rep", "Validator", "unknown_default_open_api"]
|
119
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(role)
|
120
|
+
fail ArgumentError, "invalid value for \"role\", must be one of #{allowable_values}"
|
109
121
|
end
|
110
|
-
|
111
|
-
|
122
|
+
allowable_values = ["diacap", "rmf", "reporting", "unknown_default_open_api"]
|
123
|
+
if @api_client.config.client_side_validation && opts[:'policy'] && !allowable_values.include?(opts[:'policy'])
|
124
|
+
fail ArgumentError, "invalid value for \"policy\", must be one of #{allowable_values}"
|
112
125
|
end
|
113
126
|
# resource path
|
114
|
-
local_var_path = '/api/system-roles/{roleCategory}'.sub('{' + 'roleCategory' + '}', role_category.to_s)
|
127
|
+
local_var_path = '/api/system-roles/{roleCategory}'.sub('{' + 'roleCategory' + '}', CGI.escape(role_category.to_s))
|
115
128
|
|
116
129
|
# query parameters
|
117
130
|
query_params = opts[:query_params] || {}
|
@@ -128,19 +141,25 @@ module EmassClient
|
|
128
141
|
form_params = opts[:form_params] || {}
|
129
142
|
|
130
143
|
# http body (model)
|
131
|
-
post_body = opts[:
|
144
|
+
post_body = opts[:debug_body]
|
145
|
+
|
146
|
+
# return_type
|
147
|
+
return_type = opts[:debug_return_type] || 'SystemRolesCategoryResponse'
|
132
148
|
|
133
|
-
|
149
|
+
# auth_names
|
150
|
+
auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
|
134
151
|
|
135
|
-
|
136
|
-
|
152
|
+
new_options = opts.merge(
|
153
|
+
:operation => :"SystemRolesApi.get_system_roles_by_category_id",
|
137
154
|
:header_params => header_params,
|
138
155
|
:query_params => query_params,
|
139
156
|
:form_params => form_params,
|
140
157
|
:body => post_body,
|
141
158
|
:auth_names => auth_names,
|
142
|
-
:return_type => return_type
|
159
|
+
:return_type => return_type
|
160
|
+
)
|
143
161
|
|
162
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
144
163
|
if @api_client.config.debugging
|
145
164
|
@api_client.config.logger.debug "API called: SystemRolesApi#get_system_roles_by_category_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
146
165
|
end
|
@@ -1,14 +1,17 @@
|
|
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.
|
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.</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
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: v3.3
|
7
7
|
Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
10
|
+
|
10
11
|
=end
|
11
12
|
|
13
|
+
require 'cgi'
|
14
|
+
|
12
15
|
module EmassClient
|
13
16
|
class SystemsApi
|
14
17
|
attr_accessor :api_client
|
@@ -18,10 +21,10 @@ module EmassClient
|
|
18
21
|
end
|
19
22
|
# Get system information for a specific system
|
20
23
|
# Returns the system matching provided parameters
|
21
|
-
# @param system_id **System Id**: The unique system record identifier.
|
24
|
+
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
22
25
|
# @param [Hash] opts the optional parameters
|
23
|
-
# @option opts [
|
24
|
-
# @option opts [String] :policy **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information. (default to rmf)
|
26
|
+
# @option opts [Boolean] :include_package **Include Package**: Indicates if additional packages information is retrieved for queried system. (default to true)
|
27
|
+
# @option opts [String] :policy **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information. (default to 'rmf')
|
25
28
|
# @return [SystemResponse]
|
26
29
|
def get_system(system_id, opts = {})
|
27
30
|
data, _status_code, _headers = get_system_with_http_info(system_id, opts)
|
@@ -30,10 +33,10 @@ module EmassClient
|
|
30
33
|
|
31
34
|
# Get system information for a specific system
|
32
35
|
# Returns the system matching provided parameters
|
33
|
-
# @param system_id **System Id**: The unique system record identifier.
|
36
|
+
# @param system_id [Integer] **System Id**: The unique system record identifier.
|
34
37
|
# @param [Hash] opts the optional parameters
|
35
|
-
# @option opts [
|
36
|
-
# @option opts [String] :policy **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information.
|
38
|
+
# @option opts [Boolean] :include_package **Include Package**: Indicates if additional packages information is retrieved for queried system. (default to true)
|
39
|
+
# @option opts [String] :policy **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information. (default to 'rmf')
|
37
40
|
# @return [Array<(SystemResponse, Integer, Hash)>] SystemResponse data, response status code and response headers
|
38
41
|
def get_system_with_http_info(system_id, opts = {})
|
39
42
|
if @api_client.config.debugging
|
@@ -43,11 +46,12 @@ module EmassClient
|
|
43
46
|
if @api_client.config.client_side_validation && system_id.nil?
|
44
47
|
fail ArgumentError, "Missing the required parameter 'system_id' when calling SystemsApi.get_system"
|
45
48
|
end
|
46
|
-
|
47
|
-
|
49
|
+
allowable_values = ["diacap", "rmf", "reporting", "unknown_default_open_api"]
|
50
|
+
if @api_client.config.client_side_validation && opts[:'policy'] && !allowable_values.include?(opts[:'policy'])
|
51
|
+
fail ArgumentError, "invalid value for \"policy\", must be one of #{allowable_values}"
|
48
52
|
end
|
49
53
|
# resource path
|
50
|
-
local_var_path = '/api/systems/{systemId}'.sub('{' + 'systemId' + '}', system_id.to_s)
|
54
|
+
local_var_path = '/api/systems/{systemId}'.sub('{' + 'systemId' + '}', CGI.escape(system_id.to_s))
|
51
55
|
|
52
56
|
# query parameters
|
53
57
|
query_params = opts[:query_params] || {}
|
@@ -63,36 +67,43 @@ module EmassClient
|
|
63
67
|
form_params = opts[:form_params] || {}
|
64
68
|
|
65
69
|
# http body (model)
|
66
|
-
post_body = opts[:
|
70
|
+
post_body = opts[:debug_body]
|
67
71
|
|
68
|
-
|
72
|
+
# return_type
|
73
|
+
return_type = opts[:debug_return_type] || 'SystemResponse'
|
69
74
|
|
70
|
-
|
71
|
-
|
75
|
+
# auth_names
|
76
|
+
auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
|
77
|
+
|
78
|
+
new_options = opts.merge(
|
79
|
+
:operation => :"SystemsApi.get_system",
|
72
80
|
:header_params => header_params,
|
73
81
|
:query_params => query_params,
|
74
82
|
:form_params => form_params,
|
75
83
|
:body => post_body,
|
76
84
|
:auth_names => auth_names,
|
77
|
-
:return_type => return_type
|
85
|
+
:return_type => return_type
|
86
|
+
)
|
78
87
|
|
88
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
79
89
|
if @api_client.config.debugging
|
80
90
|
@api_client.config.logger.debug "API called: SystemsApi#get_system\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
81
91
|
end
|
82
92
|
return data, status_code, headers
|
83
93
|
end
|
94
|
+
|
84
95
|
# Get system information
|
85
96
|
# Returns all system(s) that match the query parameters
|
86
97
|
# @param [Hash] opts the optional parameters
|
87
|
-
# @option opts [
|
88
|
-
# @option opts [String] :registration_type **Registration Type**: Filter record by selected registration type (single value or comma delimited values). *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider (default to regular)
|
98
|
+
# @option opts [Boolean] :include_package **Include Package**: Indicates if additional packages information is retrieved for queried system. (default to true)
|
99
|
+
# @option opts [String] :registration_type **Registration Type**: Filter record by selected registration type (single value or comma delimited values). *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider (default to 'regular')
|
89
100
|
# @option opts [String] :ditpr_id **DITPR ID**: Filter query by DoD Information Technology (IT) Portfolio Repository (DITPR).
|
90
101
|
# @option opts [String] :coams_id **COAMS ID**: Filter query by Cyber Operational Attributes Management System (COAMS).
|
91
|
-
# @option opts [String] :policy **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information. (default to rmf)
|
92
|
-
# @option opts [
|
93
|
-
# @option opts [
|
94
|
-
# @option opts [
|
95
|
-
# @return [
|
102
|
+
# @option opts [String] :policy **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information. (default to 'rmf')
|
103
|
+
# @option opts [Boolean] :include_ditpr_metrics **Include DITPR**: Indicates if DITPR metrics are retrieved. This query string parameter can only be used in conjunction with the following parameters:<br> <ul> <li>registrationType</li> <li>policy</li> </ul> (default to false)
|
104
|
+
# @option opts [Boolean] :include_decommissioned **Include Decommissioned Systems**: Indicates if decommissioned systems are retrieved. If no value is specified, the default returns true to include decommissioned systems. (default to true)
|
105
|
+
# @option opts [Boolean] :reports_for_scorecard **DoD Cyber Hygiene Scorecard**: Indicates if the system reports to the DoD Cyber Hygiene Scorecard. (default to true)
|
106
|
+
# @return [SystemsResponse]
|
96
107
|
def get_systems(opts = {})
|
97
108
|
data, _status_code, _headers = get_systems_with_http_info(opts)
|
98
109
|
data
|
@@ -101,21 +112,22 @@ module EmassClient
|
|
101
112
|
# Get system information
|
102
113
|
# Returns all system(s) that match the query parameters
|
103
114
|
# @param [Hash] opts the optional parameters
|
104
|
-
# @option opts [
|
105
|
-
# @option opts [String] :registration_type **Registration Type**: Filter record by selected registration type (single value or comma delimited values). *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider
|
115
|
+
# @option opts [Boolean] :include_package **Include Package**: Indicates if additional packages information is retrieved for queried system. (default to true)
|
116
|
+
# @option opts [String] :registration_type **Registration Type**: Filter record by selected registration type (single value or comma delimited values). *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider (default to 'regular')
|
106
117
|
# @option opts [String] :ditpr_id **DITPR ID**: Filter query by DoD Information Technology (IT) Portfolio Repository (DITPR).
|
107
118
|
# @option opts [String] :coams_id **COAMS ID**: Filter query by Cyber Operational Attributes Management System (COAMS).
|
108
|
-
# @option opts [String] :policy **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information.
|
109
|
-
# @option opts [
|
110
|
-
# @option opts [
|
111
|
-
# @option opts [
|
112
|
-
# @return [Array<(
|
119
|
+
# @option opts [String] :policy **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information. (default to 'rmf')
|
120
|
+
# @option opts [Boolean] :include_ditpr_metrics **Include DITPR**: Indicates if DITPR metrics are retrieved. This query string parameter can only be used in conjunction with the following parameters:<br> <ul> <li>registrationType</li> <li>policy</li> </ul> (default to false)
|
121
|
+
# @option opts [Boolean] :include_decommissioned **Include Decommissioned Systems**: Indicates if decommissioned systems are retrieved. If no value is specified, the default returns true to include decommissioned systems. (default to true)
|
122
|
+
# @option opts [Boolean] :reports_for_scorecard **DoD Cyber Hygiene Scorecard**: Indicates if the system reports to the DoD Cyber Hygiene Scorecard. (default to true)
|
123
|
+
# @return [Array<(SystemsResponse, Integer, Hash)>] SystemsResponse data, response status code and response headers
|
113
124
|
def get_systems_with_http_info(opts = {})
|
114
125
|
if @api_client.config.debugging
|
115
126
|
@api_client.config.logger.debug 'Calling API: SystemsApi.get_systems ...'
|
116
127
|
end
|
117
|
-
|
118
|
-
|
128
|
+
allowable_values = ["diacap", "rmf", "reporting", "unknown_default_open_api"]
|
129
|
+
if @api_client.config.client_side_validation && opts[:'policy'] && !allowable_values.include?(opts[:'policy'])
|
130
|
+
fail ArgumentError, "invalid value for \"policy\", must be one of #{allowable_values}"
|
119
131
|
end
|
120
132
|
# resource path
|
121
133
|
local_var_path = '/api/systems'
|
@@ -140,19 +152,25 @@ module EmassClient
|
|
140
152
|
form_params = opts[:form_params] || {}
|
141
153
|
|
142
154
|
# http body (model)
|
143
|
-
post_body = opts[:
|
155
|
+
post_body = opts[:debug_body]
|
156
|
+
|
157
|
+
# return_type
|
158
|
+
return_type = opts[:debug_return_type] || 'SystemsResponse'
|
144
159
|
|
145
|
-
|
160
|
+
# auth_names
|
161
|
+
auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
|
146
162
|
|
147
|
-
|
148
|
-
|
163
|
+
new_options = opts.merge(
|
164
|
+
:operation => :"SystemsApi.get_systems",
|
149
165
|
:header_params => header_params,
|
150
166
|
:query_params => query_params,
|
151
167
|
:form_params => form_params,
|
152
168
|
:body => post_body,
|
153
169
|
:auth_names => auth_names,
|
154
|
-
:return_type => return_type
|
170
|
+
:return_type => return_type
|
171
|
+
)
|
155
172
|
|
173
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
156
174
|
if @api_client.config.debugging
|
157
175
|
@api_client.config.logger.debug "API called: SystemsApi#get_systems\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
158
176
|
end
|