emasser 1.0.0

data/emass_client/ruby_client/docs/SystemsApi.md

@@ -0,0 +1,155 @@
+# SwaggerClient::SystemsApi
+
+All URIs are relative to *http://localhost:4010*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_system**](SystemsApi.md#get_system) | **GET** /api/systems/{systemId} | Get system information for a specific system
+[**get_systems**](SystemsApi.md#get_systems) | **GET** /api/systems | Get system information
+
+# **get_system**
+> SystemResponse get_system(system_id, opts)
+
+Get system information for a specific system
+
+Returns the system matching provided parameters
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure API key authorization: mockType
+  config.api_key['Prefer'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Prefer'] = 'Bearer'
+
+  # Configure API key authorization: userid
+  config.api_key['user-uid'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['user-uid'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::SystemsApi.new
+system_id = 56 # Integer | **System Id**: The unique system record identifier.
+opts = { 
+  include_package: true, # BOOLEAN | **Include Package**:  Indicates if additional packages information is retrieved for queried system.
+  policy: 'rmf' # String | **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information.
+}
+
+begin
+  #Get system information for a specific system
+  result = api_instance.get_system(system_id, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling SystemsApi->get_system: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **system_id** | **Integer**| **System Id**: The unique system record identifier. | 
+ **include_package** | **BOOLEAN**| **Include Package**:  Indicates if additional packages information is retrieved for queried system. | [optional] [default to true]
+ **policy** | **String**| **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information. | [optional] [default to rmf]
+
+### Return type
+
+[**SystemResponse**](SystemResponse.md)
+
+### Authorization
+
+[apikey](../README.md#apikey), [mockType](../README.md#mockType), [userid](../README.md#userid)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_systems**
+> SystemResponse get_systems(opts)
+
+Get system information
+
+Returns all system(s) that match the query parameters
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure API key authorization: mockType
+  config.api_key['Prefer'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Prefer'] = 'Bearer'
+
+  # Configure API key authorization: userid
+  config.api_key['user-uid'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['user-uid'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::SystemsApi.new
+opts = { 
+  include_package: true, # BOOLEAN | **Include Package**:  Indicates if additional packages information is retrieved for queried system.
+  registration_type: 'regular', # String | **Registration Type**: Filter record by selected registration type (single value or comma delimited values).  *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider  
+  ditpr_id: 'ditpr_id_example', # String | **DITPR ID**: Filter query by DoD Information Technology (IT) Portfolio Repository (DITPR).
+  coams_id: 'coams_id_example', # String | **COAMS ID**: Filter query by Cyber Operational Attributes Management System (COAMS).
+  policy: 'rmf', # String | **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information.
+  include_ditpr_metrics: false, # BOOLEAN | **Include DITPR**: Indicates if DITPR metrics are retrieved. This query string parameter can only be used in conjunction with the following parameters:<br>   <ul>     <li>registrationType</li>     <li>policy</li>   </ul>
+  include_decommissioned: true, # BOOLEAN | **Include Decommissioned Systems**: Indicates if decommissioned systems are retrieved. If no value is specified, the default returns true to include decommissioned systems.
+  reports_for_scorecard: true # BOOLEAN | **DoD Cyber Hygiene Scorecard**: Indicates if the system reports to the DoD Cyber Hygiene Scorecard.
+}
+
+begin
+  #Get system information
+  result = api_instance.get_systems(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling SystemsApi->get_systems: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **include_package** | **BOOLEAN**| **Include Package**:  Indicates if additional packages information is retrieved for queried system. | [optional] [default to true]
+ **registration_type** | **String**| **Registration Type**: Filter record by selected registration type (single value or comma delimited values).  *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider   | [optional] [default to regular]
+ **ditpr_id** | **String**| **DITPR ID**: Filter query by DoD Information Technology (IT) Portfolio Repository (DITPR). | [optional] 
+ **coams_id** | **String**| **COAMS ID**: Filter query by Cyber Operational Attributes Management System (COAMS). | [optional] 
+ **policy** | **String**| **System Policy**: Filter query by system policy. If no value is specified and more than one policy is available, the default return is the RMF policy information. | [optional] [default to rmf]
+ **include_ditpr_metrics** | **BOOLEAN**| **Include DITPR**: Indicates if DITPR metrics are retrieved. This query string parameter can only be used in conjunction with the following parameters:&lt;br&gt;   &lt;ul&gt;     &lt;li&gt;registrationType&lt;/li&gt;     &lt;li&gt;policy&lt;/li&gt;   &lt;/ul&gt; | [optional] [default to false]
+ **include_decommissioned** | **BOOLEAN**| **Include Decommissioned Systems**: Indicates if decommissioned systems are retrieved. If no value is specified, the default returns true to include decommissioned systems. | [optional] [default to true]
+ **reports_for_scorecard** | **BOOLEAN**| **DoD Cyber Hygiene Scorecard**: Indicates if the system reports to the DoD Cyber Hygiene Scorecard. | [optional] [default to true]
+
+### Return type
+
+[**SystemResponse**](SystemResponse.md)
+
+### Authorization
+
+[apikey](../README.md#apikey), [mockType](../README.md#mockType), [userid](../README.md#userid)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/emass_client/ruby_client/docs/Test.md

@@ -0,0 +1,8 @@
+# SwaggerClient::Test
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Model200**](Model200.md) |  | [optional] 
+**data** | [**TestData**](TestData.md) |  | [optional] 
+

data/emass_client/ruby_client/docs/TestApi.md

@@ -0,0 +1,66 @@
+# SwaggerClient::TestApi
+
+All URIs are relative to *http://localhost:4010*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**test_connection**](TestApi.md#test_connection) | **GET** /api | Test connection to the API
+
+# **test_connection**
+> Test test_connection
+
+Test connection to the API
+
+Returns endpoint call status
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure API key authorization: mockType
+  config.api_key['Prefer'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Prefer'] = 'Bearer'
+
+  # Configure API key authorization: userid
+  config.api_key['user-uid'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['user-uid'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::TestApi.new
+
+begin
+  #Test connection to the API
+  result = api_instance.test_connection
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling TestApi->test_connection: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Test**](Test.md)
+
+### Authorization
+
+[apikey](../README.md#apikey), [mockType](../README.md#mockType), [userid](../README.md#userid)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/emass_client/ruby_client/docs/TestData.md

@@ -0,0 +1,7 @@
+# SwaggerClient::TestData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **BOOLEAN** |  | [optional] 
+

data/emass_client/ruby_client/docs/TestResultsApi.md

@@ -0,0 +1,144 @@
+# SwaggerClient::TestResultsApi
+
+All URIs are relative to *http://localhost:4010*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_test_results_by_system_id**](TestResultsApi.md#add_test_results_by_system_id) | **POST** /api/systems/{systemId}/test-results | Add one or many test results in a system
+[**get_system_test_results**](TestResultsApi.md#get_system_test_results) | **GET** /api/systems/{systemId}/test-results | Get one or many test results in a system
+
+# **add_test_results_by_system_id**
+> TestResultsResponsePost add_test_results_by_system_id(bodysystem_id)
+
+Add one or many test results in a system
+
+Adds test results for given `systemId`  **Request Body Required Fields** - `cci` - `testedBy` - `testDate` - `description` - `complianceStatus`
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure API key authorization: mockType
+  config.api_key['Prefer'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Prefer'] = 'Bearer'
+
+  # Configure API key authorization: userid
+  config.api_key['user-uid'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['user-uid'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::TestResultsApi.new
+body = SwaggerClient::TestResultsRequestPostBody.new # TestResultsRequestPostBody | Update an existing control by Id
+system_id = 56 # Integer | **System Id**: The unique system record identifier.
+
+
+begin
+  #Add one or many test results in a system
+  result = api_instance.add_test_results_by_system_id(bodysystem_id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling TestResultsApi->add_test_results_by_system_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**TestResultsRequestPostBody**](TestResultsRequestPostBody.md)| Update an existing control by Id | 
+ **system_id** | **Integer**| **System Id**: The unique system record identifier. | 
+
+### Return type
+
+[**TestResultsResponsePost**](TestResultsResponsePost.md)
+
+### Authorization
+
+[apikey](../README.md#apikey), [mockType](../README.md#mockType), [userid](../README.md#userid)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_system_test_results**
+> TestResultsResponseGet get_system_test_results(system_id, opts)
+
+Get one or many test results in a system
+
+Returns system test results information for matching parameters.<br>
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure API key authorization: mockType
+  config.api_key['Prefer'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Prefer'] = 'Bearer'
+
+  # Configure API key authorization: userid
+  config.api_key['user-uid'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['user-uid'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::TestResultsApi.new
+system_id = 56 # Integer | **System Id**: The unique system record identifier.
+opts = { 
+  control_acronyms: 'control_acronyms_example', # String | **System Acronym**: Filter query by given system acronym (single or comma separated).
+  ccis: 'ccis_example', # String | **CCI System**: Filter query by Control Correlation Identifiers (CCIs).
+  latest_only: true # BOOLEAN | **Latest Results Only**: Indicates that only the latest test resultes are retrieved (single or comma separated).
+}
+
+begin
+  #Get one or many test results in a system
+  result = api_instance.get_system_test_results(system_id, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling TestResultsApi->get_system_test_results: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **system_id** | **Integer**| **System Id**: The unique system record identifier. | 
+ **control_acronyms** | **String**| **System Acronym**: Filter query by given system acronym (single or comma separated). | [optional] 
+ **ccis** | **String**| **CCI System**: Filter query by Control Correlation Identifiers (CCIs). | [optional] 
+ **latest_only** | **BOOLEAN**| **Latest Results Only**: Indicates that only the latest test resultes are retrieved (single or comma separated). | [optional] [default to true]
+
+### Return type
+
+[**TestResultsResponseGet**](TestResultsResponseGet.md)
+
+### Authorization
+
+[apikey](../README.md#apikey), [mockType](../README.md#mockType), [userid](../README.md#userid)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/emass_client/ruby_client/docs/TestResultsGet.md

@@ -0,0 +1,15 @@
+# SwaggerClient::TestResultsGet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**system_id** | **Integer** | [Required] Unique eMASS identifier. Will need to provide correct number | [optional] 
+**control** | **String** | [Read-Only] Control acronym associated with the test result. NIST SP 800-53 Revision 4 defined. | [optional] 
+**cci** | **String** | [Required] CCI associated with test result. | [optional] 
+**is_inherited** | **BOOLEAN** | [Read-only] Indicates whether a test result is inherited. | [optional] 
+**tested_by** | **String** | [Required] Last Name, First Name. 100 Characters. | [optional] 
+**test_date** | **Integer** | [Required] Unix time format. | [optional] 
+**description** | **String** | [Required] Include description of test result. 4000 Characters. | [optional] 
+**type** | **String** | [Read-Only] Indicates the location in the Control Approval Chain when the test result is submitted. | [optional] 
+**compliance_status** | **String** | [Required] Test result compliance status | [optional] 
+

data/emass_client/ruby_client/docs/TestResultsPost.md

@@ -0,0 +1,9 @@
+# SwaggerClient::TestResultsPost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cci** | **String** | CCI associated with test result. | [optional] 
+**success** | **BOOLEAN** | Indicates if operations result (success/fail) | [optional] 
+**system_id** | **Integer** | The system identifier for the system being updated. | [optional] 
+

data/emass_client/ruby_client/docs/TestResultsRequestPostBody.md

@@ -0,0 +1,11 @@
+# SwaggerClient::TestResultsRequestPostBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cci** | **String** | [Required] CCI associated with test result. | 
+**tested_by** | **String** | [Required] Last Name, First Name. 100 Characters. | 
+**test_date** | **Integer** | [Required] Unix time format. | 
+**description** | **String** | [Required] Include description of test result. 4000 Characters. | 
+**compliance_status** | **String** | [Required] Test result compliance status | 
+

data/emass_client/ruby_client/docs/TestResultsResponseGet.md

@@ -0,0 +1,8 @@
+# SwaggerClient::TestResultsResponseGet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Model200**](Model200.md) |  | [optional] 
+**data** | [**Array<TestResultsGet>**](TestResultsGet.md) |  | [optional] 
+

data/emass_client/ruby_client/docs/TestResultsResponsePost.md

@@ -0,0 +1,8 @@
+# SwaggerClient::TestResultsResponsePost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Model200**](Model200.md) |  | [optional] 
+**data** | [**Array<TestResultsPost>**](TestResultsPost.md) |  | [optional] 
+

data/emass_client/ruby_client/docs/Users.md

@@ -0,0 +1,9 @@
+# SwaggerClient::Users
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+

data/emass_client/ruby_client/docs/WorkflowDefinitionGet.md

@@ -0,0 +1,11 @@
+# SwaggerClient::WorkflowDefinitionGet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | [Read-Only] Description of the workflow or the stage transition. For stage transitions, this matches the action dropdown that appears for PAC users. | [optional] 
+**is_active** | **BOOLEAN** | [Read-Only] Returns true if the workflow is available to the site. | [optional] 
+**version** | **String** | [Read-Only] Version of the workflow definition. | [optional] 
+**workflow** | **String** | [Read-Only] The workflow type. | [optional] 
+**stages** | [**Array<Stage>**](Stage.md) |  | [optional] 
+

data/emass_client/ruby_client/docs/WorkflowDefinitionResponseGet.md

@@ -0,0 +1,8 @@
+# SwaggerClient::WorkflowDefinitionResponseGet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**Model200**](Model200.md) |  | [optional] 
+**data** | [**Array<WorkflowDefinitionGet>**](WorkflowDefinitionGet.md) |  | [optional] 
+

data/emass_client/ruby_client/docs/WorkflowDefinitionsApi.md

@@ -0,0 +1,74 @@
+# SwaggerClient::WorkflowDefinitionsApi
+
+All URIs are relative to *http://localhost:4010*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_workflow_definitions**](WorkflowDefinitionsApi.md#get_workflow_definitions) | **GET** /api/workflow-definitions | Get workflow definitions in a site
+
+# **get_workflow_definitions**
+> WorkflowDefinitionResponseGet get_workflow_definitions(opts)
+
+Get workflow definitions in a site
+
+View all workflow schemas available on the eMASS instance filtered by  status `includeInactive` and registration type `registrationType`.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure API key authorization: mockType
+  config.api_key['Prefer'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Prefer'] = 'Bearer'
+
+  # Configure API key authorization: userid
+  config.api_key['user-uid'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['user-uid'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::WorkflowDefinitionsApi.new
+opts = { 
+  include_inactive: true, # BOOLEAN | **Include Inactive**: If no value is specified, the default returns false to not include outdated workflow definitions.
+  registration_type: 'regular' # String | **Registration Type**: Filter record by selected registration type (single value or comma delimited values).  *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider  
+}
+
+begin
+  #Get workflow definitions in a site
+  result = api_instance.get_workflow_definitions(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling WorkflowDefinitionsApi->get_workflow_definitions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **include_inactive** | **BOOLEAN**| **Include Inactive**: If no value is specified, the default returns false to not include outdated workflow definitions. | [optional] [default to true]
+ **registration_type** | **String**| **Registration Type**: Filter record by selected registration type (single value or comma delimited values).  *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider   | [optional] [default to regular]
+
+### Return type
+
+[**WorkflowDefinitionResponseGet**](WorkflowDefinitionResponseGet.md)
+
+### Authorization
+
+[apikey](../README.md#apikey), [mockType](../README.md#mockType), [userid](../README.md#userid)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+