Module: EmassClient

Defined in:: lib/emass_client/version.rb,
lib/emass_client.rb,
lib/emass_client/api_error.rb,
lib/emass_client/api_client.rb,
lib/emass_client/api/cac_api.rb,
lib/emass_client/api/pac_api.rb,
lib/emass_client/models/ssps.rb,
lib/emass_client/models/test.rb,
lib/emass_client/api/poam_api.rb,
lib/emass_client/api/test_api.rb,
lib/emass_client/models/roles.rb,
lib/emass_client/models/stage.rb,
lib/emass_client/models/users.rb,
lib/emass_client/configuration.rb,
lib/emass_client/models/cac_get.rb,
lib/emass_client/models/pac_get.rb,
lib/emass_client/models/systems.rb,
lib/emass_client/api/systems_api.rb,
lib/emass_client/models/cmmc_get.rb,
lib/emass_client/models/pac_post.rb,
lib/emass_client/models/poam_get.rb,
lib/emass_client/models/register.rb,
lib/emass_client/api/controls_api.rb,
lib/emass_client/models/test_data.rb,
lib/emass_client/api/artifacts_api.rb,
lib/emass_client/api/dashboards_api.rb,
lib/emass_client/api/milestones_api.rb,
lib/emass_client/models/response200.rb,
lib/emass_client/models/response201.rb,
lib/emass_client/models/response400.rb,
lib/emass_client/models/response401.rb,
lib/emass_client/models/response403.rb,
lib/emass_client/models/response404.rb,
lib/emass_client/models/response405.rb,
lib/emass_client/models/response411.rb,
lib/emass_client/models/response490.rb,
lib/emass_client/models/response500.rb,
lib/emass_client/models/controls_get.rb,
lib/emass_client/models/controls_put.rb,
lib/emass_client/api/registration_api.rb,
lib/emass_client/api/system_roles_api.rb,
lib/emass_client/api/test_results_api.rb,
lib/emass_client/models/artifacts_get.rb,
lib/emass_client/models/register_data.rb,
lib/emass_client/models/role_category.rb,
lib/emass_client/models/milestones_get.rb,
lib/emass_client/models/system_response.rb,
lib/emass_client/models/cac_response_get.rb,
lib/emass_client/models/pac_response_get.rb,
lib/emass_client/models/response201_meta.rb,
lib/emass_client/models/response400_meta.rb,
lib/emass_client/models/response401_meta.rb,
lib/emass_client/models/response403_meta.rb,
lib/emass_client/models/response405_meta.rb,
lib/emass_client/models/response411_meta.rb,
lib/emass_client/models/response490_meta.rb,
lib/emass_client/models/response500_meta.rb,
lib/emass_client/models/static_code_post.rb,
lib/emass_client/models/systems_response.rb,
lib/emass_client/models/test_results_get.rb,
lib/emass_client/api/artifacts_export_api.rb,
lib/emass_client/api/cmmc_assessments_api.rb,
lib/emass_client/models/cac_response_post.rb,
lib/emass_client/models/cmmc_response_get.rb,
lib/emass_client/models/connectivity_ccsd.rb,
lib/emass_client/models/pac_response_post.rb,
lib/emass_client/models/poam_post_put_del.rb,
lib/emass_client/models/poam_response_put.rb,
lib/emass_client/models/test_results_post.rb,
lib/emass_client/api/static_code_scans_api.rb,
lib/emass_client/models/poam_response_post.rb,
lib/emass_client/api/workflow_instances_api.rb,
lib/emass_client/models/success200_response.rb,
lib/emass_client/models/cloud_resources_post.rb,
lib/emass_client/models/poam_response_delete.rb,
lib/emass_client/api/workflow_definitions_api.rb,
lib/emass_client/models/controls_response_get.rb,
lib/emass_client/models/controls_response_put.rb,
lib/emass_client/models/instances_transitions.rb,
lib/emass_client/models/system_roles_response.rb,
lib/emass_client/models/workflow_instance_get.rb,
lib/emass_client/models/artifacts_response_del.rb,
lib/emass_client/models/artifacts_response_get.rb,
lib/emass_client/models/definition_transitions.rb,
lib/emass_client/models/milestone_response_get.rb,
lib/emass_client/models/milestone_response_put.rb,
lib/emass_client/models/workflow_instances_get.rb,
lib/emass_client/api/cloud_resource_results_api.rb,
lib/emass_client/api/container_scan_results_api.rb,
lib/emass_client/models/milestone_response_post.rb,
lib/emass_client/models/milestones_required_put.rb,
lib/emass_client/models/poam_response_get_poams.rb,
lib/emass_client/models/static_code_application.rb,
lib/emass_client/models/workflow_definition_get.rb,
lib/emass_client/models/containers_response_post.rb,
lib/emass_client/models/milestones_required_post.rb,
lib/emass_client/models/containers_resources_post.rb,
lib/emass_client/models/poam_response_get_systems.rb,
lib/emass_client/models/static_code_response_post.rb,
lib/emass_client/models/test_results_response_get.rb,
lib/emass_client/models/milestones_put_post_delete.rb,
lib/emass_client/models/test_results_response_post.rb,
lib/emass_client/models/artifacts_response_put_post.rb,
lib/emass_client/models/cac_response_post_data_inner.rb,
lib/emass_client/models/cloud_resources_response_post.rb,
lib/emass_client/models/static_code_request_post_body.rb,
lib/emass_client/models/poam_request_delete_body_inner.rb,
lib/emass_client/models/success200_response_data_inner.rb,
lib/emass_client/models/system_roles_category_response.rb,
lib/emass_client/models/workflow_instance_response_get.rb,
lib/emass_client/models/register_user_request_post_body.rb,
lib/emass_client/models/workflow_instances_response_get.rb,
lib/emass_client/models/milestone_response_get_milestone.rb,
lib/emass_client/models/system_roles_response_data_inner.rb,
lib/emass_client/models/workflow_definition_response_get.rb,
lib/emass_client/models/artifacts_response_del_data_inner.rb,
lib/emass_client/models/artifacts_request_delete_body_inner.rb,
lib/emass_client/models/milestones_request_delete_body_inner.rb,
lib/emass_client/models/artifacts_response_put_post_data_inner.rb,
lib/emass_client/models/static_code_request_post_body_application.rb,
lib/emass_client/models/workflow_instances_response_get_pagination.rb

Overview

#Enterprise Mission Assurance Support Service (eMASS)

#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. Register External Application (that use the eMASS API) New users will need to [register](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. 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. Available Request Headers <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> Approve API Client for Actionable Requests 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:

The version of the OpenAPI document: v3.9 Contact: [email protected] Generated by: openapi-generator.tech OpenAPI Generator version: 7.0.0-SNAPSHOT

Defined Under Namespace

Classes: ApiClient, ApiError, ArtifactsApi, ArtifactsExportApi, ArtifactsGet, ArtifactsRequestDeleteBodyInner, ArtifactsResponseDel, ArtifactsResponseDelDataInner, ArtifactsResponseGet, ArtifactsResponsePutPost, ArtifactsResponsePutPostDataInner, CACApi, CMMCAssessmentsApi, CacGet, CacResponseGet, CacResponsePost, CacResponsePostDataInner, CloudResourceResultsApi, CloudResourcesPost, CloudResourcesResponsePost, CmmcGet, CmmcResponseGet, Configuration, ConnectivityCcsd, ContainerScanResultsApi, ContainersResourcesPost, ContainersResponsePost, ControlsApi, ControlsGet, ControlsPut, ControlsResponseGet, ControlsResponsePut, DashboardsApi, DefinitionTransitions, InstancesTransitions, MilestoneResponseGet, MilestoneResponseGetMilestone, MilestoneResponsePost, MilestoneResponsePut, MilestonesApi, MilestonesGet, MilestonesPutPostDelete, MilestonesRequestDeleteBodyInner, MilestonesRequiredPost, MilestonesRequiredPut, PACApi, POAMApi, PacGet, PacPost, PacResponseGet, PacResponsePost, PoamGet, PoamPostPutDel, PoamRequestDeleteBodyInner, PoamResponseDelete, PoamResponseGetPoams, PoamResponseGetSystems, PoamResponsePost, PoamResponsePut, Register, RegisterData, RegisterUserRequestPostBody, RegistrationApi, Response200, Response201, Response201Meta, Response400, Response400Meta, Response401, Response401Meta, Response403, Response403Meta, Response404, Response405, Response405Meta, Response411, Response411Meta, Response490, Response490Meta, Response500, Response500Meta, RoleCategory, Roles, Ssps, Stage, StaticCodeApplication, StaticCodePost, StaticCodeRequestPostBody, StaticCodeRequestPostBodyApplication, StaticCodeResponsePost, StaticCodeScansApi, Success200Response, Success200ResponseDataInner, SystemResponse, SystemRolesApi, SystemRolesCategoryResponse, SystemRolesResponse, SystemRolesResponseDataInner, Systems, SystemsApi, SystemsResponse, Test, TestApi, TestData, TestResultsApi, TestResultsGet, TestResultsPost, TestResultsResponseGet, TestResultsResponsePost, Users, WorkflowDefinitionGet, WorkflowDefinitionResponseGet, WorkflowDefinitionsApi, WorkflowInstanceGet, WorkflowInstanceResponseGet, WorkflowInstancesApi, WorkflowInstancesGet, WorkflowInstancesResponseGet, WorkflowInstancesResponseGetPagination

Constant Summary collapse

VERSION =

'3.9.1'

Class Method Summary collapse

.configure ⇒ Object

Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ `Object`

Customize default settings for the SDK using block.

EmassClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File 'lib/emass_client.rb', line 147

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end