{ "openapi": "3.0.1", "info": { "title": "OpenAPI definition", "version": "v0" }, "servers": [ { "url": "http://localhost:8080", "description": "Generated server url" } ], "paths": { "/api/{customerToken}/snowflake/authentications": { "put": { "tags": [ "snowflake-integration-controller" ], "operationId": "updateIntegrationAuthentication", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSnowflakeIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SnowflakeSourceAuthenticationSecure" } } } } } }, "post": { "tags": [ "snowflake-integration-controller" ], "operationId": "createIntegrationAuthentication", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSnowflakeIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SnowflakeSourceAuthenticationSecure" } } } } } } }, "/api/{customerToken}/settings/user/update": { "put": { "tags": [ "user-settings-controller" ], "operationId": "updateUser", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserSettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BasicUserDto" } } } } } } }, "/api/{customerToken}/roles/{id}": { "get": { "tags": [ "role-controller" ], "operationId": "getRole", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Role" } } } } } }, "put": { "tags": [ "role-controller" ], "operationId": "updateRole", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Role" } } } } } }, "delete": { "tags": [ "role-controller" ], "operationId": "deleteRole", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risks/{riskId}/owners": { "put": { "tags": [ "risk-controller" ], "operationId": "updateRiskOwners", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risks/{riskId}/bah/recalculate": { "put": { "tags": [ "risk-controller" ], "operationId": "recalculateVistaDataByRiskId", "parameters": [ { "name": "riskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risks/owners/{ownerId}": { "put": { "tags": [ "risk-controller" ], "operationId": "removeOwnerFromRisks", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risks/bah/{id}": { "get": { "tags": [ "risk-controller" ], "operationId": "getBahRisk", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BahRiskDto" } } } } } }, "put": { "tags": [ "risk-controller" ], "operationId": "updateBahRisk", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBahRiskRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risks/bah/assessment/{assessmentId}/recalculate": { "put": { "tags": [ "risk-controller" ], "operationId": "recalculateVistaDataByAssessmentId", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risk-remediation-projects/{id}": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskRemediationProject", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRemediationProject" } } } } } }, "put": { "tags": [ "risk-remediation-project-controller" ], "operationId": "updateRiskRemediationProject", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskRemediationProjectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRemediationProject" } } } } } }, "delete": { "tags": [ "risk-remediation-project-controller" ], "operationId": "deleteRiskRemediationProject", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risk-registers/{riskRegisterId}": { "put": { "tags": [ "risk-register-controller" ], "operationId": "updateRiskRegister", "parameters": [ { "name": "riskRegisterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskRegisterUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRegisterDto" } } } } } }, "delete": { "tags": [ "risk-register-controller" ], "operationId": "deleteRiskRegister", "parameters": [ { "name": "riskRegisterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risk-nist-types/{id}": { "get": { "tags": [ "risk-nist-type-controller" ], "operationId": "getRiskNistTypesById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskNistTypeSummary" } } } } } }, "put": { "tags": [ "risk-nist-type-controller" ], "operationId": "updateRiskNistTypeById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRiskNistTypeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskNistTypeSummary" } } } } } }, "delete": { "tags": [ "risk-nist-type-controller" ], "operationId": "deleteRiskNistTypeById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risk-model-configs/{riskModelId}": { "get": { "tags": [ "risk-model-config-controller" ], "operationId": "findRiskModelConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskModelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskModelConfig" } } } } } }, "put": { "tags": [ "risk-model-config-controller" ], "operationId": "updateRiskModel", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskModelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskModelConfigRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskModelConfig" } } } } } }, "delete": { "tags": [ "risk-model-config-controller" ], "operationId": "deleteRiskModel", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskModelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/policy-templates/{policyTemplateId}": { "get": { "tags": [ "integration-controller" ], "operationId": "getCustomerPolicyTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PolicyTemplate" } } } } } }, "put": { "tags": [ "integration-controller" ], "operationId": "updateCustomerPolicyTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdatePolicyTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/organizational-units/{id}": { "get": { "tags": [ "organizational-unit-controller" ], "operationId": "getOrganizationalUnit", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/OrganizationalUnit" } } } } } }, "put": { "tags": [ "organizational-unit-controller" ], "operationId": "updateOrganizationalUnit", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateOrganizationalUnitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/OrganizationalUnit" } } } } } }, "delete": { "tags": [ "organizational-unit-controller" ], "operationId": "deleteOrganizationalUnit", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/notifications": { "get": { "tags": [ "notification-controller" ], "operationId": "getCatalog", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentNotifications" } } } } } } }, "put": { "tags": [ "notification-controller" ], "operationId": "updateNotifications", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNotificationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentNotifications" } } } } } } } }, "/api/{customerToken}/notifications/defaults": { "put": { "tags": [ "notification-controller" ], "operationId": "updateDefaultNotifications", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDefaultNotificationsRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/api/{customerToken}/nist-800-30-risks/{id}": { "get": { "tags": [ "risk-controller" ], "operationId": "findRiskNist80030Dto_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/RiskNist80030ExtraDataDto" }, { "$ref": "#/components/schemas/RiskNist80030Dto" } ] } } } } } }, "put": { "tags": [ "risk-controller" ], "operationId": "updateNist80030Risk", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNist80030RiskRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskAndNist80030Risk" } } } } } } }, "/api/{customerToken}/nist-800-30-risk-templates/{id}/controls/{controlId}": { "put": { "tags": [ "nist-80030-risk-template-controller" ], "operationId": "updateControlToNist80030RiskTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlWeights" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Nist80030RiskTemplateXControl" } } } } } }, "delete": { "tags": [ "nist-80030-risk-template-controller" ], "operationId": "removeAssociatedControlsToNist80030RiskTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/manage/user/{userId}": { "put": { "tags": [ "user-controller" ], "operationId": "updateUser_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BasicUserDto" } } } } } }, "delete": { "tags": [ "user-controller" ], "operationId": "disableUser", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/manage/tag-group/{tagGroupId}": { "get": { "tags": [ "assessment-tag-management-controller" ], "operationId": "findAssessmentTagGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentTagGroupAndTagsDto" } } } } } }, "put": { "tags": [ "assessment-tag-management-controller" ], "operationId": "updateTagGroup", "parameters": [ { "name": "tagGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTagGroupWithTagRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentTagGroupAndTagsDto" } } } } } }, "delete": { "tags": [ "assessment-tag-management-controller" ], "operationId": "deleteTagGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/{customerToken}/manage/tag-group/{tagGroupId}/tag/{tagId}": { "put": { "tags": [ "assessment-tag-management-controller" ], "operationId": "updateTag", "parameters": [ { "name": "tagGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentTagDto" } } } } } }, "delete": { "tags": [ "assessment-tag-management-controller" ], "operationId": "deleteTag", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tagGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentTagGroupAndTagsDto" } } } } } } }, "/api/{customerToken}/manage/framework/{frameworkId}/update": { "put": { "tags": [ "framework-management-controller" ], "operationId": "updateFramework", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFrameworkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/{customerToken}/manage/assessment/{assessmentId}": { "put": { "tags": [ "assessment-management-controller" ], "operationId": "updateAssessment", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssessmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentDto" } } } } } }, "delete": { "tags": [ "assessment-management-controller" ], "operationId": "deleteAssessment", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/{customerToken}/manage/assessment/{assessmentId}/clone": { "put": { "tags": [ "assessment-management-controller" ], "operationId": "cloneAssessment", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneAssessmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentDto" } } } } } } }, "/api/{customerToken}/jira-config": { "put": { "tags": [ "jira-controller" ], "operationId": "createOrUpdateConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateJiraConfigRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/JiraConfig" } } } } } }, "delete": { "tags": [ "jira-controller" ], "operationId": "deleteConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/ibm/authentications": { "put": { "tags": [ "ibm-integration-controller" ], "operationId": "updateIntegrationAuthentication_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIbmIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/IbmSourceAuthenticationSecure" } } } } } }, "post": { "tags": [ "ibm-integration-controller" ], "operationId": "createIntegrationAuthentication_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIbmIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/IbmSourceAuthenticationSecure" } } } } } } }, "/api/{customerToken}/groups/{id}": { "get": { "tags": [ "group-controller" ], "operationId": "retrieveGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Group" } } } } } }, "put": { "tags": [ "group-controller" ], "operationId": "updateGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Group" } } } } } }, "delete": { "tags": [ "group-controller" ], "operationId": "deleteGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/governance-dashboards/{dashboardId}/widgets/{widgetId}": { "get": { "tags": [ "governance-dashboard-widget-controller" ], "operationId": "findWidgetById", "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "widgetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GovernanceWidgetResponse" } } } } } }, "put": { "tags": [ "governance-dashboard-widget-controller" ], "operationId": "updateGovernanceDashboardWidget", "parameters": [ { "name": "widgetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "dashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGovernanceDashboardWidgetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "governance-dashboard-widget-controller" ], "operationId": "deleteGovernanceWidget", "parameters": [ { "name": "widgetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/governance-dashboard/{dashboardId}": { "get": { "tags": [ "governance-dashboard-controller" ], "operationId": "getDashboardById", "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GovernanceDashboardPageResponse" } } } } } }, "put": { "tags": [ "governance-dashboard-controller" ], "operationId": "updateDashboard", "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModifyGovernanceDashboardRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GovernanceDashboardPage" } } } } } } }, "/api/{customerToken}/feature-flags/{featureFlagId}": { "put": { "tags": [ "feature-flag-controller" ], "operationId": "updateFeatureFlag", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "featureFlagId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureFlagUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FeatureFlag" } } } } } } }, "/api/{customerToken}/fair-risks/{id}": { "get": { "tags": [ "fair-risk-controller" ], "operationId": "findFairRiskAndFairDtoById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FairRiskAndOwnersDto" } } } } } }, "put": { "tags": [ "fair-risk-controller" ], "operationId": "updateFairRisk", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFairRiskRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FairRisk" } } } } } } }, "/api/{customerToken}/executive-dashboard/{id}": { "get": { "tags": [ "executive-dashboard-controller" ], "operationId": "getExecutiveDashboard_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExecutiveDashboardDto" } } } } } }, "put": { "tags": [ "executive-dashboard-controller" ], "operationId": "updateExecutiveDashboard", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateExecutiveDashboardDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExecutiveDashboardDto" } } } } } }, "delete": { "tags": [ "executive-dashboard-controller" ], "operationId": "deleteExecutiveDashboard", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/{customerToken}/data-lake-templates/{templateId}": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getCustomerDataLakeTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataLakeTemplate" } } } } } }, "put": { "tags": [ "data-lake-template-controller" ], "operationId": "updateCustomerDataLakeTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateDataLakeTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/data-lake-query-templates/{queryTemplateId}": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getCustomerDataLakeQueryTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "queryTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataLakeQueryTemplate" } } } } } }, "put": { "tags": [ "data-lake-template-controller" ], "operationId": "updateCustomerDataLakeQueryTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "queryTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateDataLakeQueryTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/cyber-insight-templates/{id}": { "put": { "tags": [ "cyber-insight-template-controller" ], "operationId": "updateCyberInsightTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CyberInsightTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CyberInsightTemplate" } } } } } }, "delete": { "tags": [ "cyber-insight-template-controller" ], "operationId": "deleteCyberInsightTemplateById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/customer/historical-data-timeframe": { "put": { "tags": [ "customer-controller" ], "operationId": "updateHistoricalDataTimeframe", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateHistoricalDataTimeframeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CustomerDefaults" } } } } } } }, "/api/{customerToken}/customer/control-weights": { "put": { "tags": [ "customer-controller" ], "operationId": "updateControlWeights", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateControlWeightsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CustomerDefaults" } } } } } } }, "/api/{customerToken}/customer/config": { "get": { "tags": [ "customer-controller" ], "operationId": "getAdminConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AdminCustomerConfig" } } } } } }, "put": { "tags": [ "customer-controller" ], "operationId": "updateConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConfigRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/custom-reports/{reportId}/targets": { "get": { "tags": [ "custom-report-controller" ], "operationId": "getTargetFields", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } } }, "put": { "tags": [ "custom-report-controller" ], "operationId": "updateReportTargets", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomReportTargetsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/crosswalk-templates/{crosswalkTemplateId}/mappings": { "get": { "tags": [ "crosswalk-template-controller" ], "operationId": "findCrosswalkTemplateMappings", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "crosswalkTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkTemplateMappingDetails" } } } } } } }, "put": { "tags": [ "crosswalk-template-controller" ], "operationId": "upsertCrosswalkTemplateMapping", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "crosswalkTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrosswalkTemplateMappingRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkTemplateMappingDetails" } } } } } } } }, "/api/{customerToken}/control-score-actions/{controlScoreActionId}/annotations/{id}": { "put": { "tags": [ "control-score-action-controller" ], "operationId": "updateAnnotation", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlScoreActionAnnotation" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlScoreActionAnnotation" } } } } } } }, "/api/{customerToken}/connectors/{id}": { "get": { "tags": [ "connector-controller" ], "operationId": "getConnector", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Connector" } } } } } }, "put": { "tags": [ "connector-controller" ], "operationId": "updateConnector", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AwsConnectorRequest" }, { "$ref": "#/components/schemas/AzureConnectorRequest" }, { "$ref": "#/components/schemas/QualysConnectorRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Connector" } } } } } }, "delete": { "tags": [ "connector-controller" ], "operationId": "deleteConnector", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/{customerToken}/aws/authentications": { "get": { "tags": [ "aws-integration-controller" ], "operationId": "getIntegrationAuthentications_6", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AwsSourceAuthentication" } } } } } } }, "put": { "tags": [ "aws-integration-controller" ], "operationId": "updateIntegrationAuthentication_2", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAwsIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AwsSourceAuthentication" } } } } } }, "post": { "tags": [ "aws-integration-controller" ], "operationId": "createIntegrationAuthentication_3", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAwsIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AwsSourceAuthentication" } } } } } } }, "/api/{customerToken}/authentication-methods/{id}": { "get": { "tags": [ "authentication-method-controller" ], "operationId": "getAuthenticationMethodDetails", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AuthenticationMethodDetails" } } } } } }, "put": { "tags": [ "authentication-method-controller" ], "operationId": "updateAuthenticationMethod", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveAuthenticationMethod" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AuthenticationMethod" } } } } } }, "delete": { "tags": [ "authentication-method-controller" ], "operationId": "deleteAuthenticationMethod", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/asset-types/{assetTypeId}": { "get": { "tags": [ "asset-type-controller" ], "operationId": "findAssetTypeWithAttributesAndAssetGroupsDtoByAssetTypeId", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetTypeWithAttributesAndAssetGroupsDto" } } } } } }, "put": { "tags": [ "asset-type-controller" ], "operationId": "updateAssetType", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetTypeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetType" } } } } } }, "delete": { "tags": [ "asset-type-controller" ], "operationId": "deleteAssetType", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/asset-groups/{assetGroupId}": { "get": { "tags": [ "asset-group-controller" ], "operationId": "findAssetGroupSummaryDto", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetGroupSummaryDto" } } } } } }, "put": { "tags": [ "asset-group-controller" ], "operationId": "updateAssetGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetGroupRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetGroup" } } } } } }, "delete": { "tags": [ "asset-group-controller" ], "operationId": "deleteAssetGroup", "parameters": [ { "name": "assetGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/asset-attributes/{assetAttributeId}": { "get": { "tags": [ "asset-attribute-controller" ], "operationId": "findAssetAttributeById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetAttributeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetAttributeDetailsDto" } } } } } }, "put": { "tags": [ "asset-attribute-controller" ], "operationId": "updateAssetAttribute", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetAttributeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssetAttributeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "asset-attribute-controller" ], "operationId": "deleteAssetAttribute", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetAttributeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/assessments/{assessmentId}/workflow-status": { "put": { "tags": [ "assessment-controller" ], "operationId": "updateAssessmentWorkflowStatus", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssessmentWorkflowRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Assessment" } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/import": { "put": { "tags": [ "assessment-controller" ], "operationId": "importAssessment", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientTimeZone", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ImportAssessmentResponse" } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/control-scores/{controlScoreId}/dcmm-maturities": { "put": { "tags": [ "maturity-model-controller" ], "operationId": "updateDcmmMaturity", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDCMMMaturityRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DCMMMaturityModelModuleEntry" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/project/{projectId}": { "get": { "tags": [ "project-controller" ], "operationId": "findProjectById", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } } } }, "put": { "tags": [ "project-controller" ], "operationId": "updateProject", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } } } }, "delete": { "tags": [ "project-controller" ], "operationId": "deleteProject", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/assessment/{assessmentId}/control-score/{controlScoreId}/maturity": { "put": { "tags": [ "maturity-model-controller" ], "operationId": "updateMaturity", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaturityUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MaturityModelModuleEntry" } } } } } } }, "/api/{customerToken}/assessment-automations/{id}": { "put": { "tags": [ "integration-controller" ], "operationId": "updateAssessmentAutomation", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssessmentAutomationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AutomatedAssessmentDefinitionAndPartsDto" } } } } } } }, "/api/{customerToken}/assessment-automations/{automationDefinitionId}/connectors/{connectorId}/filters": { "put": { "tags": [ "integration-controller" ], "operationId": "updateAssessmentAutomationConnectorFilters", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "automationDefinitionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectorId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssessmentAutomationConnectorFiltersRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/artifacts/{id}": { "get": { "tags": [ "central-artifact-controller" ], "operationId": "findArtifactsById_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlScoreId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "type": "string", "format": "byte" }, { "$ref": "#/components/schemas/ArtifactAndLinksDto" } ] } } } } } }, "put": { "tags": [ "central-artifact-controller" ], "operationId": "deleteArtifactLinkFromControlScore", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlScoreId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "central-artifact-controller" ], "operationId": "createArtifactLinkFromControlScore", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlScoreId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CentralArtifactXControlScore" } } } } } }, "delete": { "tags": [ "central-artifact-controller" ], "operationId": "deleteArtifactById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "central-artifact-controller" ], "operationId": "patchCentralArtifactById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CentralArtifactPatch" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ArtifactAndLinksDto" } } } } } } }, "/api/v1/internal/provisioning/update": { "put": { "tags": [ "provisioning-controller" ], "operationId": "updateInstance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInstanceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SummaryResponse" } } } } } } }, "/api/v1/internal/provisioning/deactivate": { "put": { "tags": [ "provisioning-controller" ], "operationId": "deactivateInstance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeActiveStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/internal/provisioning/activate": { "put": { "tags": [ "provisioning-controller" ], "operationId": "activateInstance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeActiveStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/{frameworkId}/control-presets/{controlId}": { "get": { "tags": [ "control-preset-admin-controller" ], "operationId": "getControlPresets", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlPresetDto" } } } } } }, "put": { "tags": [ "control-preset-admin-controller" ], "operationId": "updateControlPreset", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlPresetDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlPresetDto" } } } } } } }, "/api/admin/{frameworkId}/control-action-presets/{controlId}": { "put": { "tags": [ "control-preset-admin-controller" ], "operationId": "updateControlActionPreset", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlActionPresetDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlActionPresetDto" } } } } } } }, "/api/admin/score-guidance-set": { "put": { "tags": [ "score-guidance-admin-controller" ], "operationId": "updateScoreGuidanceSet", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScoreGuidanceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "score-guidance-admin-controller" ], "operationId": "createNewScoreGuidanceSet", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScoreGuidanceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/scheduled-job/{id}": { "put": { "tags": [ "scheduled-job-controller" ], "operationId": "updateJob", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledJob" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/scheduled-job-settings": { "get": { "tags": [ "scheduled-job-controller" ], "operationId": "getSettings", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ScheduledJobSettings" } } } } } }, "put": { "tags": [ "scheduled-job-controller" ], "operationId": "updateSettings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledJobSettings" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/report-types/{reportTypeId}": { "get": { "tags": [ "admin-report-controller" ], "operationId": "getReportType", "parameters": [ { "name": "reportTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ReportType" } } } } } }, "put": { "tags": [ "admin-report-controller" ], "operationId": "updateReportType", "parameters": [ { "name": "reportTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportType" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ReportType" } } } } } } }, "/api/admin/policy-templates/{policyTemplateId}": { "get": { "tags": [ "integration-controller" ], "operationId": "getPolicyTemplate", "parameters": [ { "name": "policyTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PolicyTemplate" } } } } } }, "put": { "tags": [ "integration-controller" ], "operationId": "updatePolicyTemplate", "parameters": [ { "name": "policyTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdatePolicyTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/framework/{frameworkId}": { "get": { "tags": [ "framework-admin-controller" ], "operationId": "findById_3", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } }, "put": { "tags": [ "framework-admin-controller" ], "operationId": "updateFramework_1", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFrameworkRequestAdmin" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/admin/framework/{frameworkId}/reorderControls": { "put": { "tags": [ "framework-admin-controller" ], "operationId": "reorderControls", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderControlRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/admin/framework/{frameworkId}/removeControl": { "put": { "tags": [ "framework-admin-controller" ], "operationId": "removeControlFromFramework", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveControlFromFrameworkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/admin/framework/{frameworkId}/addControlsByFramework": { "put": { "tags": [ "framework-admin-controller" ], "operationId": "addControlsByFramework", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddControlsByFrameworkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/admin/framework/{frameworkId}/addControl": { "put": { "tags": [ "framework-admin-controller" ], "operationId": "addControl", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddControlToFrameworkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/admin/data-lake-templates/{templateId}": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getDataLakeTemplate", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataLakeTemplate" } } } } } }, "put": { "tags": [ "data-lake-template-controller" ], "operationId": "updateDataLakeTemplate", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateDataLakeTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/data-lake-query-templates/{queryTemplateId}": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getAdminDataLakeQueryTemplate", "parameters": [ { "name": "queryTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DataLakeQueryTemplate" } } } } } }, "put": { "tags": [ "data-lake-template-controller" ], "operationId": "updateAdminDataLakeQueryTemplate", "parameters": [ { "name": "queryTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateDataLakeQueryTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/customer/{customerId}": { "get": { "tags": [ "customer-admin-controller" ], "operationId": "findById_4", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Customer" } } } } } }, "put": { "tags": [ "customer-admin-controller" ], "operationId": "updateCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Customer" } } } } } } }, "/api/admin/control/{controlId}": { "get": { "tags": [ "control-admin-controller" ], "operationId": "findControl", "parameters": [ { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlDto" } } } } } }, "put": { "tags": [ "control-admin-controller" ], "operationId": "updateControl", "parameters": [ { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlRequestData" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlDto" } } } } } }, "delete": { "tags": [ "control-admin-controller" ], "operationId": "deleteControl", "parameters": [ { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/admin/control/{controlId}/control-action/{controlActionId}": { "put": { "tags": [ "control-admin-controller" ], "operationId": "updateControlAction", "parameters": [ { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlActionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlDto" } } } } } }, "delete": { "tags": [ "control-admin-controller" ], "operationId": "deleteControlAction", "parameters": [ { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlDto" } } } } } } }, "/api/{token}/assessments/report-templates": { "get": { "tags": [ "assessment-report-template-controller" ], "operationId": "find", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentReportResponse" } } } } } } }, "post": { "tags": [ "assessment-report-template-controller" ], "operationId": "create", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/users/{userId}/groups": { "post": { "tags": [ "group-controller" ], "operationId": "manageGroupsForUser", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserGroupResults" } } } } } } }, "/api/{customerToken}/tenable/authentications": { "get": { "tags": [ "tenable-integration-controller" ], "operationId": "getIntegrationAuthentications", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenableSourceAuthenticationSecure" } } } } } } }, "post": { "tags": [ "tenable-integration-controller" ], "operationId": "saveIntegrationAuthentication", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTenableIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TenableSourceAuthenticationSecure" } } } } } }, "patch": { "tags": [ "tenable-integration-controller" ], "operationId": "updateIntegrationAuthentication_3", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTenableIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TenableSourceAuthenticationSecure" } } } } } } }, "/api/{customerToken}/tags": { "get": { "tags": [ "control-tag-controller" ], "operationId": "findAllControlTags", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlTag" } } } } } } }, "post": { "tags": [ "control-tag-controller" ], "operationId": "createTag", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlTag" } } } } } } }, "/api/{customerToken}/tags/{tagId}/control/{controlId}": { "post": { "tags": [ "control-tag-controller" ], "operationId": "addTagToControl", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "control-tag-controller" ], "operationId": "removeTagFromControl", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/supplemental-score-model": { "post": { "tags": [ "supplemental-score-model-controller" ], "operationId": "createModel", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScoreModelRequestData" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SupplementalScoreModel" } } } } } } }, "/api/{customerToken}/snowflake-push-config": { "get": { "tags": [ "snowflake-push-config-controller" ], "operationId": "getSnowflakePushConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SnowflakePushConfigSecure" } } } } } }, "post": { "tags": [ "snowflake-push-config-controller" ], "operationId": "saveSnowflakePushConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveSnowflakePushConfigRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SnowflakePushConfigSecure" } } } } } }, "delete": { "tags": [ "snowflake-push-config-controller" ], "operationId": "deleteSnowflakePushConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/roles": { "get": { "tags": [ "role-controller" ], "operationId": "searchRoles", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "groups[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "organizationalUnits[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageRole" } } } } } }, "post": { "tags": [ "role-controller" ], "operationId": "createRole", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Role" } } } } } } }, "/api/{customerToken}/roles/{id}/permissions": { "get": { "tags": [ "permission-controller" ], "operationId": "getAllPermissionsForRole", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } } } } }, "post": { "tags": [ "permission-controller" ], "operationId": "addPermissionToRole", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOrRemovePermissionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "permission-controller" ], "operationId": "removePermissionFromRole", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOrRemovePermissionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risks": { "get": { "tags": [ "risk-controller" ], "operationId": "findAllRisksSummaries_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filterParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RiskSummaryFilterParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PageRiskSummaryDto" }, { "$ref": "#/components/schemas/PageDashboardConfigurationRiskSummary" } ] } } } } } }, "post": { "tags": [ "risk-controller" ], "operationId": "createRisksFromTemplates", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRisksFromTemplatesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Risk" } } } } } } } }, "/api/{customerToken}/risks/{riskId}/controls/{controlId}": { "post": { "tags": [ "risk-controller" ], "operationId": "associateGlobalControlToRisk", "parameters": [ { "name": "riskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risks/{riskId}/control-scores/{controlScoreId}": { "post": { "tags": [ "risk-controller" ], "operationId": "associateControlScoreToRisk", "parameters": [ { "name": "riskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risks/global-controls": { "post": { "tags": [ "risk-controller" ], "operationId": "searchGlobalRiskControlsForCustomer", "parameters": [ { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalControlsQueryParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageGlobalRiskControl" } } } } } } }, "/api/{customerToken}/risks/bah": { "post": { "tags": [ "risk-controller" ], "operationId": "createBahRisk", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBahRiskRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risks/bah/{id}/controls": { "post": { "tags": [ "risk-controller" ], "operationId": "getSelectedCyberInsightControls", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlIdsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlCsfFunctions" } } } } } } } }, "/api/{customerToken}/risks/bah/assessments/{assessmentId}/controls": { "post": { "tags": [ "risk-controller" ], "operationId": "getCyberInsightControls", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskRemediationControlsFilters" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageImplControlCsfFunctions" } } } } } } }, "/api/{customerToken}/risks/assessment-controls": { "post": { "tags": [ "risk-controller" ], "operationId": "searchAssessmentControlsForCustomer", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssessmentControlsQueryParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageControlScoreLabelDto" } } } } } } }, "/api/{customerToken}/risk-remediation-projects": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskRemediationProjects_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskRemediationProjectFilters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RiskRemediationProjectFilters" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "queryParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RiskRemediationProjectSummaryFiltersParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PageRiskRemediationProjectSummary" }, { "$ref": "#/components/schemas/PageImplRiskRemediationProject" } ] } } } } } }, "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "createRiskRemediationProject", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskRemediationProjectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRemediationProject" } } } } } } }, "/api/{customerToken}/risk-remediation-projects/risk-control-score-summaries": { "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskControlScoreSummaries", "parameters": [ { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "controlAssociatedRisksFilters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ControlAssociatedRisksFilters" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetControlScoresForRisksRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageImplRemediationControlScoreSummary" } } } } } } }, "/api/{customerToken}/risk-remediation-projects/risk-assessments": { "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskAssessments", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetControlScoresForRisksRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Assessment" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/inherent-residual-risk-summary": { "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getInherentResidualRiskValues", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InherentResidualRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/InherentResidualRiskData" } } } } } } }, "/api/{customerToken}/risk-remediation-projects/csf-options": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getCsfDataForControlIds", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CsfDataFunctionOption" } } } } } } }, "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getCsfDataForRiskIds", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetControlScoresForRisksRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CsfDataFunctionOption" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/csf-functions": { "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getCsfSubcategoriesForControlIds", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskRemediationCsfFunctionsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ControlIdAndCsfSubcategory" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/csf-coverage": { "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getCsfCoverageForRiskIds", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetControlScoresForRisksRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskControlsCsfCoverage" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/csf-coverage/control-scores": { "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getCsfControlScoresByRiskIds_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetControlScoresForControlsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRemediationProjectStep3Data" } } } } } } }, "/api/{customerToken}/risk-remediation-projects/controls": { "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskRemediationControlsForCustomer", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskRemediationControlsFilters" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageImplControlAssessmentsControlScores" } } } } } } }, "/api/{customerToken}/risk-remediation-projects/controls/scores": { "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskRemediationControlScoreByControlIds", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAverageScoreForControlsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ControlAssessmentsControlScores" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/control-score-actions": { "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskControlScoresByControlScoreActionIds", "parameters": [ { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetControlScoreActionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RemediationControlScoreSummary" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/control-control-scores": { "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getControlScoresControlsForRisks", "parameters": [ { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "controlAssociatedRisksFilters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ControlAssociatedRisksFilters" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetControlScoresForRisksRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageImplControlAssociatedRisks" } } } } } } }, "/api/{customerToken}/risk-remediation-projects/assessments": { "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getControlIdsAndAssessmentsForCustomer", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetControlScoresForRiskControlsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/RiskRemediationAssessment" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/assessment-control-score-summaries": { "post": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getAssessmentControlScoreSummaries", "parameters": [ { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "controlAssociatedRisksFilters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ControlAssociatedRisksFilters" } }, { "name": "riskRemediationDashboardId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetControlScoresForAssessmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageImplRemediationControlScoreSummary" } } } } } } }, "/api/{customerToken}/risk-remediation-dashboards": { "get": { "tags": [ "risk-remediation-dashboard-controller" ], "operationId": "getRemediationDashboards", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filterParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RemediationDashboardFilterParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageImplRiskRemediationDashboard" } } } } } }, "post": { "tags": [ "risk-remediation-dashboard-controller" ], "operationId": "createRiskRemediationDashboard", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskRemediationDashboardRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRemediationDashboard" } } } } } } }, "/api/{customerToken}/risk-registers": { "get": { "tags": [ "risk-register-controller" ], "operationId": "getPaginatedRiskRegistrySummary", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RiskRegisterFilters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageImplRiskRegisterAndRiskInfoDto" } } } } } }, "post": { "tags": [ "risk-register-controller" ], "operationId": "createRiskRegister", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskRegisterRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRegisterDto" } } } } } } }, "/api/{customerToken}/risk-registers/{riskRegisterId}/advisen-sectors": { "get": { "tags": [ "risk-register-controller" ], "operationId": "findRiskRegisterSectorsAndPresetDto", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskRegisterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRegisterSectorsAndPresetsDto" } } } } } }, "post": { "tags": [ "risk-register-controller" ], "operationId": "createRiskRegisterAdvisenSectors", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskRegisterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskRegisterXAdvisenSectors" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRegisterXAdvisenSectors" } } } } } } }, "/api/{customerToken}/risk-nist-types": { "get": { "tags": [ "risk-nist-type-controller" ], "operationId": "getRiskNistTypes", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RiskNistTypeFilters" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageImplRiskNistTypeSummary" } } } } } }, "post": { "tags": [ "risk-nist-type-controller" ], "operationId": "createRiskNistType", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRiskNistTypeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskNistType" } } } } } } }, "/api/{customerToken}/risk-model-configs": { "get": { "tags": [ "risk-model-config-controller" ], "operationId": "findAllRiskModelConfigs", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskModelConfig" } } } } } } }, "post": { "tags": [ "risk-model-config-controller" ], "operationId": "createRiskModel", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskModelConfigRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskModelConfig" } } } } } } }, "/api/{customerToken}/qualys/authentications": { "get": { "tags": [ "qualys-integration-controller" ], "operationId": "getIntegrationAuthentications_2", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualysSourceAuthenticationSecure" } } } } } } }, "post": { "tags": [ "qualys-integration-controller" ], "operationId": "saveIntegrationAuthentication_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateQualysIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/QualysSourceAuthenticationSecure" } } } } } }, "patch": { "tags": [ "qualys-integration-controller" ], "operationId": "updateIntegrationAuthentication_4", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateQualysIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/QualysSourceAuthenticationSecure" } } } } } } }, "/api/{customerToken}/postgres/authentications": { "get": { "tags": [ "postgres-integration-controller" ], "operationId": "getIntegrationAuthentications_3", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PostgresSourceAuthenticationSecure" } } } } } } }, "post": { "tags": [ "postgres-integration-controller" ], "operationId": "saveIntegrationAuthentication_2", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePostgresIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PostgresSourceAuthenticationSecure" } } } } } }, "patch": { "tags": [ "postgres-integration-controller" ], "operationId": "updateIntegrationAuthentication_5", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePostgresIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PostgresSourceAuthenticationSecure" } } } } } } }, "/api/{customerToken}/policy-templates": { "get": { "tags": [ "integration-controller" ], "operationId": "getCustomerPolicyTemplatesSummary_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "frameworkName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "sourceIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "assessmentId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PolicyTemplate" } }, { "$ref": "#/components/schemas/PagePolicyTemplate" } ] } } } } } }, "post": { "tags": [ "integration-controller" ], "operationId": "createCustomerPolicyTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdatePolicyTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/organizational-units": { "post": { "tags": [ "organizational-unit-controller" ], "operationId": "createOrganizationalUnit", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateOrganizationalUnitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/OrganizationalUnit" } } } } } } }, "/api/{customerToken}/notifications/knight-vision/assessments/{assessmentId}": { "get": { "tags": [ "notification-controller" ], "operationId": "getKnightVisionSubscriptionForAssessment", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/KnightVisionAssessmentSubscriptionResponse" } } } } } }, "post": { "tags": [ "notification-controller" ], "operationId": "addKnightVisionSubscription", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnightVisionSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/KnightVisionSubscription" } } } } } } }, "/api/{customerToken}/nist-800-30-risks": { "post": { "tags": [ "risk-controller" ], "operationId": "createNist80030Risk", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNist80030RiskRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskAndNist80030Risk" } } } } } } }, "/api/{customerToken}/nist-800-30-risk-templates": { "get": { "tags": [ "nist-80030-risk-template-controller" ], "operationId": "getNist80030RiskTemplates", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Nist80030RiskTemplateFilters" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageImplNist80030RiskTemplateControlsCount" } } } } } }, "post": { "tags": [ "nist-80030-risk-template-controller" ], "operationId": "createNist80030RiskTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNist80030RiskTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Nist80030RiskTemplate" } } } } } } }, "/api/{customerToken}/nist-800-30-risk-templates/{id}/controls": { "get": { "tags": [ "nist-80030-risk-template-controller" ], "operationId": "getNist80030RiskTemplateControls", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Control" } } } } } } }, "post": { "tags": [ "nist-80030-risk-template-controller" ], "operationId": "associateControlsToNist80030RiskTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociateControlsNist80030RiskTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/manage/user": { "post": { "tags": [ "user-controller" ], "operationId": "createUser", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AdminUser" } } } } } } }, "/api/{customerToken}/manage/user/{userId}/resend-verification": { "post": { "tags": [ "user-controller" ], "operationId": "resendVerification", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResendEmailResponse" } } } } } } }, "/api/{customerToken}/manage/user/validate": { "post": { "tags": [ "user-controller" ], "operationId": "validateUser", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateNewUserRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidationResult" } } } } } } }, "/api/{customerToken}/manage/tag-group": { "get": { "tags": [ "assessment-tag-management-controller" ], "operationId": "findAllAssessmentTagGroups", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentTagGroupAndTagsDto" } } } } } } }, "post": { "tags": [ "assessment-tag-management-controller" ], "operationId": "createTagGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagGroupWithTagsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentTagGroupAndTagsDto" } } } } } } }, "/api/{customerToken}/manage/tag-group/{tagGroupId}/tag": { "post": { "tags": [ "assessment-tag-management-controller" ], "operationId": "createTag_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentTagDto" } } } } } } }, "/api/{customerToken}/manage/framework/{frameworkId}/add": { "post": { "tags": [ "framework-management-controller" ], "operationId": "addFrameworkToCustomer", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddFrameworkToCustomerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/{customerToken}/manage/assessments": { "post": { "tags": [ "assessment-management-controller" ], "operationId": "automateAssessmentCreation", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomateAssessmentCreationRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentFrameworkAndControlsDto" } } } } } } }, "/api/{customerToken}/manage/assessment": { "post": { "tags": [ "assessment-management-controller" ], "operationId": "createAssessment", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAssessmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentDto" } } } } } } }, "/api/{customerToken}/manage/assessment/{fromAssessmentId}/crosswalk": { "post": { "tags": [ "assessment-management-controller" ], "operationId": "crosswalkAssessment", "parameters": [ { "name": "fromAssessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCrosswalkAssessmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/api/{customerToken}/manage/assessment/validate": { "post": { "tags": [ "assessment-management-controller" ], "operationId": "validateAssessment", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAssessmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidateAssessmentResponse" } } } } } } }, "/api/{customerToken}/manage/assessment/validate-update": { "post": { "tags": [ "assessment-management-controller" ], "operationId": "validateAssessmentUpdate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAssessmentUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidateAssessmentResponse" } } } } } } }, "/api/{customerToken}/industry-risks": { "post": { "tags": [ "industry-risk-controller" ], "operationId": "createIndustryRisksForNist_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewIndustryRiskRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/FairRisk" } }, { "type": "array", "items": { "$ref": "#/components/schemas/Nist80030RiskEntity" } } ] } } } } } } }, "/api/{customerToken}/groups": { "get": { "tags": [ "group-controller" ], "operationId": "searchGroups_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "users[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "organizationalUnits[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "roles[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "selectedIds[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "default": [] } }, { "name": "onlyShowSelected", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "organizationalUnitId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Group" } }, { "$ref": "#/components/schemas/PageGroupSummary" } ] } } } } } }, "post": { "tags": [ "group-controller" ], "operationId": "createGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGroupRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Group" } } } } } } }, "/api/{customerToken}/groups/{groupId}/users": { "get": { "tags": [ "user-controller" ], "operationId": "findUsersByGroupId", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "organizationalUnits[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "statuses[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAdminUserDto" } } } } } }, "post": { "tags": [ "group-controller" ], "operationId": "manageUsersForGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupUserRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GroupUserResults" } } } } } } }, "/api/{customerToken}/governance-dashboards/{dashboardId}/widgets": { "get": { "tags": [ "governance-dashboard-widget-controller" ], "operationId": "findAllWidgetsForDashboard", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GovernanceWidgetResponse" } } } } } } }, "post": { "tags": [ "governance-dashboard-widget-controller" ], "operationId": "createGovernanceDashboardWidget", "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGovernanceDashboardWidgetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/governance-dashboard": { "get": { "tags": [ "governance-dashboard-controller" ], "operationId": "getPaginatedGovernanceDashboardList", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/GovernanceDashboardSummaryFilters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageImplGovernanceDashboardSummary" } } } } } }, "post": { "tags": [ "governance-dashboard-controller" ], "operationId": "createDashboard", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGovernanceDashboardRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GovernanceDashboardPage" } } } } } } }, "/api/{customerToken}/governance-dashboard/preview": { "post": { "tags": [ "governance-dashboard-controller" ], "operationId": "getChartPreview", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewGovernanceDashboardRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GovernanceDashboardPreviewResponse" } } } } } } }, "/api/{customerToken}/frameworks": { "get": { "tags": [ "framework-controller" ], "operationId": "getFrameworks_1_1_1_1_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filterParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/FrameworkAssessmentsFilterParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPublishedFramework" } }, { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkSummary" } }, { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkMaturityDto" } }, { "type": "array", "items": { "$ref": "#/components/schemas/Framework" } }, { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkAssessments" } } ] } } } } } }, "post": { "tags": [ "framework-controller" ], "operationId": "getFrameworksByIds", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrameworkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Framework" } } } } } } } }, "/api/{customerToken}/frameworks/{frameworkId}/metadata": { "get": { "tags": [ "framework-metadata-controller" ], "operationId": "findAllAsCustomer", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkMetadataField" } } } } } } }, "post": { "tags": [ "framework-metadata-controller" ], "operationId": "createAndAssociate", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFrameworkMetadataField" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkMetadataField" } } } } } } }, "/api/{customerToken}/frameworks/search": { "post": { "tags": [ "framework-controller" ], "operationId": "searchFrameworks", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrameworkSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageFramework" } } } } } } }, "/api/{customerToken}/feature-restrictions": { "post": { "tags": [ "framework-configuration-controller" ], "operationId": "featureRestriction", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFeatureRestrictionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/fair-risks": { "post": { "tags": [ "fair-risk-controller" ], "operationId": "createFairRisk", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFairRiskRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FairRisk" } } } } } } }, "/api/{customerToken}/fair-risks/{id}/evaluations": { "get": { "tags": [ "fair-risk-controller" ], "operationId": "findFairRiskEvaluations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FairRiskEvaluation" } } } } } } }, "post": { "tags": [ "fair-risk-controller" ], "operationId": "evaluateFairRisk", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateFairRiskRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FairRiskEvaluation" } } } } } } }, "/api/{customerToken}/executive-dashboard": { "get": { "tags": [ "executive-dashboard-controller" ], "operationId": "getExecutiveDashboards", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filterParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ExecutiveDashboardListFilterParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageImplExecutiveDashboardDto" } } } } } }, "post": { "tags": [ "executive-dashboard-controller" ], "operationId": "createExecutiveDashboard", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExecutiveDashboardDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/api/{customerToken}/data-lake-templates": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getCustomerDataLakeTemplateSummary_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "frameworkName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "sourceIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "assessmentId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeTemplate" } }, { "$ref": "#/components/schemas/PageDataLakeTemplate" } ] } } } } } }, "post": { "tags": [ "data-lake-template-controller" ], "operationId": "createCustomerDataLakeTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateDataLakeTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/data-lake-template-queries/validate": { "post": { "tags": [ "data-lake-template-controller" ], "operationId": "validateCustomerQuery", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateQueryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidateQueryResponse" } } } } } } }, "/api/{customerToken}/data-lake-query-templates": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getCustomerQueryTemplateSummary_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "frameworkName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "frameworkId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeQueryTemplate" } }, { "$ref": "#/components/schemas/PageDataLakeQueryTemplate" } ] } } } } } }, "post": { "tags": [ "data-lake-template-controller" ], "operationId": "createCustomerDataLakeQueryTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateDataLakeQueryTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/data-lake-query-templates/validate": { "post": { "tags": [ "data-lake-template-controller" ], "operationId": "validateCustomerQueryTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateQueryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidateQueryResponse" } } } } } } }, "/api/{customerToken}/cyber-insight-templates": { "get": { "tags": [ "cyber-insight-template-controller" ], "operationId": "findAllCyberInsightTemplates", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "assessmentId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageCyberInsightTemplateDto" } } } } } }, "post": { "tags": [ "cyber-insight-template-controller" ], "operationId": "createCyberInsightTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CyberInsightTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CyberInsightTemplate" } } } } } } }, "/api/{customerToken}/custom-reports": { "get": { "tags": [ "custom-report-controller" ], "operationId": "getCustomReportSummary", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CustomReportSummaryFilters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageImplCustomReportSummaryDto" } } } } } }, "post": { "tags": [ "custom-report-controller" ], "operationId": "createCustomReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomReportRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/api/{customerToken}/crosswalk": { "post": { "tags": [ "crosswalk-controller" ], "operationId": "crosswalk", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrosswalkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/crosswalk-templates": { "get": { "tags": [ "crosswalk-template-controller" ], "operationId": "findAllCrosswalkTemplates_1_1_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "crosswalkTemplateSearchParams", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/CrosswalkTemplateSearchParams" } }, { "name": "fromFrameworkId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "toFrameworkId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CrosswalkTemplateSearchOptions" }, { "$ref": "#/components/schemas/PageCrosswalkTemplateAndFrameworksDto" }, { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkTemplateDto" } } ] } } } } } }, "post": { "tags": [ "crosswalk-template-controller" ], "operationId": "createCrosswalkTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrosswalkTemplateRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CrosswalkTemplateDto" } } } } } } }, "/api/{customerToken}/control-scores": { "post": { "tags": [ "control-score-controller" ], "operationId": "findControlScoresForControls", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlScoresForControlsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlScoresForControlsResponse" } } } } } } }, "/api/{customerToken}/control-score-details": { "post": { "tags": [ "control-score-controller" ], "operationId": "findControlScoreDetails", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlQueryParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageControlScoreDetailsDto" } } } } } } }, "/api/{customerToken}/control-score-details-ids": { "post": { "tags": [ "control-score-controller" ], "operationId": "findControlScoreDetailsIds", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlQueryParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreDetailsIds" } } } } } } } }, "/api/{customerToken}/control-score-actions/{controlScoreActionId}/annotations": { "post": { "tags": [ "control-score-action-controller" ], "operationId": "createControlActionScoreAnnotation", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlScoreActionAnnotation" } } } } } } }, "/api/{customerToken}/connectors": { "get": { "tags": [ "connector-controller" ], "operationId": "searchConnectors", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "organizationalUnits", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "sourceIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "selectedIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "onlyShowSelected", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageConnector" } } } } } }, "post": { "tags": [ "connector-controller" ], "operationId": "createConnector", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AwsConnectorRequest" }, { "$ref": "#/components/schemas/AzureConnectorRequest" }, { "$ref": "#/components/schemas/QualysConnectorRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Connector" } } } } } } }, "/api/{customerToken}/configuration/control-workflow/create": { "post": { "tags": [ "control-workflow-definition-configuration-controller" ], "operationId": "createWorkflowGroupDefinition", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkflowGroupDefinition" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/azure/authentications": { "post": { "tags": [ "azure-integration-controller" ], "operationId": "createIntegrationAuthentication_2", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUpdateAzureIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AzureSourceAuthenticationSecure" } } } } } }, "patch": { "tags": [ "azure-integration-controller" ], "operationId": "updateIntegrationAuthentication_6", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUpdateAzureIntegrationAuthenticationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AzureSourceAuthenticationSecure" } } } } } } }, "/api/{customerToken}/authentication-methods": { "get": { "tags": [ "authentication-method-controller" ], "operationId": "getPaginatedAuthenticationMethods_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "authenticationTypes[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "SAML", "OIDC", "PASSWORD" ] } } }, { "name": "organizationalUnits[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "domain", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "organizationalUnitId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/AuthenticationMethod" } }, { "$ref": "#/components/schemas/PageAuthenticationMethodSummary" } ] } } } } } }, "post": { "tags": [ "authentication-method-controller" ], "operationId": "createAuthenticationGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveAuthenticationMethod" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AuthenticationMethod" } } } } } } }, "/api/{customerToken}/audit-logs/tracked-event": { "post": { "tags": [ "audit-log-controller" ], "operationId": "createTrackedEvent", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditLogTrackedEventRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/asset-types": { "get": { "tags": [ "asset-type-controller" ], "operationId": "findAllAssetTypes_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AssetTypeViewFilters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PageAssetTypeWithAttributesAndAssetGroupsDto" }, { "type": "array", "items": { "$ref": "#/components/schemas/AssetType" } } ] } } } } } }, "post": { "tags": [ "asset-type-controller" ], "operationId": "createAssetType", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetTypeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetType" } } } } } } }, "/api/{customerToken}/asset-groups": { "get": { "tags": [ "asset-group-controller" ], "operationId": "findAllAssetGroups_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AssetGroupFilters" } }, { "name": "queryFilters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AssetGroupQueryFilters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/AssetGroupSummaryDto" } }, { "$ref": "#/components/schemas/PageAssetGroup" } ] } } } } } }, "post": { "tags": [ "asset-group-controller" ], "operationId": "createAssetGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetGroupRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetGroup" } } } } } } }, "/api/{customerToken}/asset-groups/{assetGroupId}/risk-registers": { "get": { "tags": [ "asset-group-controller" ], "operationId": "findAssociatedRiskRegisters", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRegisterInherentResidualRisk" } } } } } } }, "post": { "tags": [ "asset-group-controller" ], "operationId": "manageRiskRegistersForAssetGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetGroupAssociationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetGroupRiskRegisterResults" } } } } } } }, "/api/{customerToken}/asset-groups/{assetGroupId}/assessments": { "get": { "tags": [ "asset-group-controller" ], "operationId": "findAssociatedAssessments", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAssessmentSummary" } } } } } }, "post": { "tags": [ "asset-group-controller" ], "operationId": "manageAssessmentsForAssetGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetGroupAssociationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetGroupAssessmentResults" } } } } } } }, "/api/{customerToken}/asset-attributes": { "get": { "tags": [ "asset-attribute-controller" ], "operationId": "findAssetAttributesAndValues", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filterParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AssetAttributeFilters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAssetAttributeAndListOptionsEntry" } } } } } }, "post": { "tags": [ "asset-attribute-controller" ], "operationId": "createAssetAttribute", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAssetAttributeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssetAttributeAndListOptions" } } } } } } }, "/api/{customerToken}/assessments": { "post": { "tags": [ "assessment-controller" ], "operationId": "findAllAssessments", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "assessmentFilters": { "$ref": "#/components/schemas/AssessmentFilters" }, "pageable": { "$ref": "#/components/schemas/Pageable" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAssessment" } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/score-model-value-set-ids": { "post": { "tags": [ "assessment-controller" ], "operationId": "findScoreModelValueSetIdsByControlIdsAndAssessmentId", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScoreModelValueSetIdsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/import-automation-results": { "post": { "tags": [ "integration-controller" ], "operationId": "importAutomationResults", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ImportAutomationResultsResponse" } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/connectors": { "post": { "tags": [ "connector-controller" ], "operationId": "manageConnectorsForAssessment", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssessmentConnectorRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentConnectorResults" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/report/csf/scores": { "post": { "tags": [ "dashboard-metrics-controller" ], "operationId": "findCsfCharts", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CsfScoresRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CsfAndControlFamilyChartsForAssessment" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/project": { "get": { "tags": [ "project-controller" ], "operationId": "findAllProjects", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } } } } } }, "post": { "tags": [ "project-controller" ], "operationId": "createSnapshot", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/control-score/{controlScoreId}/jira/create": { "post": { "tags": [ "control-score-controller" ], "operationId": "createJira", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJiraTicketRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlScore" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/control-score/{controlScoreId}/control-score-reminder": { "post": { "tags": [ "control-score-controller" ], "operationId": "createControlScoreReminder", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlScoreReminderDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlScoreReminderDto" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/control-score/assessor/{controlScoreId}": { "post": { "tags": [ "assessor-module-controller" ], "operationId": "createDocRef", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentReference" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessorModuleEntry" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/bulkAssign": { "post": { "tags": [ "bulk-assign-controller" ], "operationId": "bulkAssign", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentDto" } } } } } } }, "/api/{customerToken}/assessment-workflow-groups/create": { "post": { "tags": [ "assessment-workflow-controller" ], "operationId": "createAssessmentWorkflow", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveAssessmentWorkflowDefinition" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/api/{customerToken}/assessment-automations": { "get": { "tags": [ "integration-controller" ], "operationId": "getAssessmentAutomations", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "authenticationDefIds[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "assessmentAutomationIds[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AutomatedAssessmentDefinitionAndPartsDto" } } } } } } }, "post": { "tags": [ "integration-controller" ], "operationId": "saveAssessmentAutomation", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveAssessmentAutomationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AutomatedAssessmentDefinitionAndPartsDto" } } } } } } }, "/api/{customerToken}/assessment-automations/{assessmentId}/execute": { "post": { "tags": [ "integration-controller" ], "operationId": "runSpecificAssessmentAutomationForSource", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/artifacts": { "get": { "tags": [ "central-artifact-controller" ], "operationId": "findAllArtifactsByCustomer", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "centralArtifactFilters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CentralArtifactFilters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageArtifactAndLinksDto" } } } } } }, "post": { "tags": [ "central-artifact-controller" ], "operationId": "createEvidenceArtifactForControlScore_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CentralArtifact" } } } } } } }, "/api/{customerToken}/api-keys": { "get": { "tags": [ "api-key-controller" ], "operationId": "findAllApiKeys", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyResponse" } } } } } } }, "post": { "tags": [ "api-key-controller" ], "operationId": "generateApiKey", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenerateApiKeyResponse" } } } } } } }, "/api/v1/internal/provisioning/summary": { "post": { "tags": [ "provisioning-controller" ], "operationId": "summary", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummaryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SummaryResponse" } } } } } } }, "/api/v1/internal/provisioning/provision": { "post": { "tags": [ "provisioning-controller" ], "operationId": "provisionInstance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisionInstanceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SummaryResponse" } } } } } } }, "/api/admin/vulnerability-scan-templates": { "post": { "tags": [ "vulnerability-scan-template-controller" ], "operationId": "createVulnerabilityScanTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVulnerabilityScanTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/score-model/create": { "post": { "tags": [ "score-model-admin-controller" ], "operationId": "createModel_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScoreModelRequestData" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ScoreModel" } } } } } } }, "/api/admin/scheduled-jobs/{scheduledJobId}/results": { "post": { "tags": [ "scheduled-job-controller" ], "operationId": "runScheduledJob", "parameters": [ { "name": "scheduledJobId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ScheduledJobResult" } } } } } } }, "/api/admin/policy-templates": { "get": { "tags": [ "integration-controller" ], "operationId": "getPolicyTemplatesSummary", "parameters": [ { "name": "controlName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "frameworkName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PagePolicyTemplate" } } } } } }, "post": { "tags": [ "integration-controller" ], "operationId": "createPolicyTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdatePolicyTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/informational-controls/informational-controls-option-sets": { "get": { "tags": [ "informational-controls-controller" ], "operationId": "getOptionSets", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InformationalControlsOptionSetDto" } } } } } } }, "post": { "tags": [ "informational-controls-controller" ], "operationId": "createOptionSet", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationalControlsOptionSetDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/InformationalControlsOptionSetDto" } } } } } } }, "/api/admin/informational-controls/informational-controls-controls": { "get": { "tags": [ "informational-controls-controller" ], "operationId": "getControls", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InformationalControlsControlDto" } } } } } } }, "post": { "tags": [ "informational-controls-controller" ], "operationId": "createControl", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InformationalControlsControlDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/InformationalControlsControlDto" } } } } } } }, "/api/admin/framework": { "get": { "tags": [ "framework-admin-controller" ], "operationId": "findSummary", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminFrameworkSummary" } } } } } } }, "post": { "tags": [ "framework-admin-controller" ], "operationId": "createFramework", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFrameworkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/admin/framework/{frameworkId}/import": { "post": { "tags": [ "framework-admin-controller" ], "operationId": "importControls", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "controlImport" ], "type": "object", "properties": { "controlImport": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/framework/{frameworkId}/controls": { "post": { "tags": [ "framework-admin-controller" ], "operationId": "addNewControl", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlRequestData" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/admin/data-lake-templates": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getDataLakeTemplateSummary", "parameters": [ { "name": "controlName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "frameworkName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageDataLakeTemplate" } } } } } }, "post": { "tags": [ "data-lake-template-controller" ], "operationId": "createDataLakeTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateDataLakeTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/data-lake-template-queries/validate": { "post": { "tags": [ "data-lake-template-controller" ], "operationId": "validateQuery", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateQueryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidateQueryResponse" } } } } } } }, "/api/admin/data-lake-query-templates": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getCustomerQueryTemplateSummary_2", "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "frameworkName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "frameworkId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeQueryTemplate" } }, { "$ref": "#/components/schemas/PageDataLakeQueryTemplate" } ] } } } } } }, "post": { "tags": [ "data-lake-template-controller" ], "operationId": "createAdminDataLakeQueryTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateDataLakeQueryTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/data-lake-query-templates/validate": { "post": { "tags": [ "data-lake-template-controller" ], "operationId": "validateAdminQueryTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateQueryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ValidateQueryResponse" } } } } } } }, "/api/admin/customer": { "get": { "tags": [ "customer-admin-controller" ], "operationId": "findAll_3", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } } } } } }, "post": { "tags": [ "customer-admin-controller" ], "operationId": "createCustomer", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Customer" } } } } } } }, "/api/admin/customer/{customerId}/risks/reevaluate": { "post": { "tags": [ "customer-admin-controller" ], "operationId": "reevaluateRisks", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/admin/crosswalk-mappings": { "get": { "tags": [ "crosswalk-mapping-controller" ], "operationId": "findAllCrosswalkMappings", "parameters": [ { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageCrosswalkMappingFullDto" } } } } } }, "post": { "tags": [ "crosswalk-mapping-controller" ], "operationId": "createCrosswalkMappings", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "required": true }, "responses": { "207": { "description": "Multi-Status", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateCrosswalkMappingsResponse" } } } } } } } }, "/api/admin/control": { "get": { "tags": [ "control-admin-controller" ], "operationId": "findAll_4", "parameters": [ { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "excludeFrameworkControls", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "catalogs[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "framework", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageControlDto" } } } } } }, "post": { "tags": [ "control-admin-controller" ], "operationId": "createControl_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlRequestData" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlDto" } } } } } } }, "/api/admin/control/{controlId}/control-action": { "get": { "tags": [ "control-admin-controller" ], "operationId": "findControlActions", "parameters": [ { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlDto" } } } } } }, "post": { "tags": [ "control-admin-controller" ], "operationId": "createControlAction", "parameters": [ { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlActionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlDto" } } } } } } }, "/api/admin/control-action/{controlActionId}/score-guidance-set": { "post": { "tags": [ "score-guidance-admin-controller" ], "operationId": "updateAssignedScoreGuidanceSet", "parameters": [ { "name": "controlActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlActionScoreGuidanceUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/catalog": { "get": { "tags": [ "control-catalog-controller" ], "operationId": "findAllCatalogs", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlCatalogDto" } } } } } } }, "post": { "tags": [ "control-catalog-controller" ], "operationId": "createControlCatalog", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateControlCatalogRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlCatalogDto" } } } } } } }, "/api/admin/api-keys": { "get": { "tags": [ "internal-api-key-controller" ], "operationId": "findAllApiKeys_1", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyResponse" } } } } } } }, "post": { "tags": [ "internal-api-key-controller" ], "operationId": "generateApiKey_1", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenerateApiKeyResponse" } } } } } } }, "/api/account/verification_token": { "post": { "tags": [ "user-verify-controller" ], "operationId": "verifyAndEnableUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyUserRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/settings/user/two-factor/enable": { "patch": { "tags": [ "user-settings-controller" ], "operationId": "enable2Fa", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnableMultiFactorRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/settings/user/two-factor/disable": { "patch": { "tags": [ "user-settings-controller" ], "operationId": "disable2Fa", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/settings/user/resetPassword": { "patch": { "tags": [ "user-settings-controller" ], "operationId": "resetPassword", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordResetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserDto2" } } } } } } }, "/api/{customerToken}/risks/{riskId}": { "delete": { "tags": [ "risk-controller" ], "operationId": "deleteRisk", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "risk-controller" ], "operationId": "patchRisk", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskPatch" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Risk" } } } } } } }, "/api/{customerToken}/risk-remediation-dashboards/{id}": { "get": { "tags": [ "risk-remediation-dashboard-controller" ], "operationId": "getRemediationDashboard", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRemediationDashboard" } } } } } }, "delete": { "tags": [ "risk-remediation-dashboard-controller" ], "operationId": "deleteRiskRemediationDashboardById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "risk-remediation-dashboard-controller" ], "operationId": "updateRemediationDashboard", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskRemediationDashboardRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRemediationDashboard" } } } } } } }, "/api/{customerToken}/risk-models/{riskModelId}": { "patch": { "tags": [ "risk-model-controller" ], "operationId": "updateRiskModel_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskModelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchRiskModelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/nist-800-30-risk-templates/{id}": { "get": { "tags": [ "nist-80030-risk-template-controller" ], "operationId": "getNist80030RiskTemplateById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Nist80030RiskTemplate" } } } } } }, "delete": { "tags": [ "nist-80030-risk-template-controller" ], "operationId": "deleteNist80030RiskTemplateById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "nist-80030-risk-template-controller" ], "operationId": "patchNist80030RiskTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNist80030RiskTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Nist80030RiskTemplate" } } } } } } }, "/api/{customerToken}/nist-800-30-risk-templates/{id}/risk-template-data": { "patch": { "tags": [ "nist-80030-risk-template-controller" ], "operationId": "patchRiskTemplateData", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRiskTemplateDataRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskTemplateData" } } } } } } }, "/api/{customerToken}/nist-800-30-risk-templates/{id}/nist-800-30-risk-template-data": { "patch": { "tags": [ "nist-80030-risk-template-controller" ], "operationId": "patchNist80030RiskTemplateData", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNist80030RiskTemplateDataRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Nist80030RiskTemplateData" } } } } } } }, "/api/{customerToken}/manage/user/{userId}/reset-password": { "patch": { "tags": [ "user-controller" ], "operationId": "resetPassword_1", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/manage/user/{userId}/enable": { "patch": { "tags": [ "user-controller" ], "operationId": "enableUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/manage/user/{userId}/email-verify": { "patch": { "tags": [ "user-controller" ], "operationId": "verifyUserEmail", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserVerification" } } } } } } }, "/api/{customerToken}/manage/user/{userId}/disable-2fa": { "patch": { "tags": [ "user-controller" ], "operationId": "disable2FactorAuth", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/manage/framework/{frameworkId}/enable": { "patch": { "tags": [ "framework-management-controller" ], "operationId": "enableFramework", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/{customerToken}/manage/framework/{frameworkId}/disable": { "patch": { "tags": [ "framework-management-controller" ], "operationId": "disableFramework", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/{customerToken}/custom-reports/{reportId}": { "get": { "tags": [ "custom-report-controller" ], "operationId": "getReportById", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CustomReport" } } } } } }, "delete": { "tags": [ "custom-report-controller" ], "operationId": "deleteCustomReport", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "custom-report-controller" ], "operationId": "editCustomReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditCustomReportRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/api/{customerToken}/custom-reports/{reportId}/fields": { "get": { "tags": [ "custom-report-controller" ], "operationId": "getReportFields", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } } }, "patch": { "tags": [ "custom-report-controller" ], "operationId": "updateReportFields", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomReportFieldsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/custom-reports/{reportId}/favorite": { "patch": { "tags": [ "custom-report-controller" ], "operationId": "toggleFavorite", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToggleFavoriteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/crosswalk-templates/{id}": { "get": { "tags": [ "crosswalk-template-controller" ], "operationId": "findCrosswalkTemplateById_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CrosswalkTemplateAndMappingDto" }, { "$ref": "#/components/schemas/CrosswalkTemplateDto" } ] } } } } } }, "delete": { "tags": [ "crosswalk-template-controller" ], "operationId": "deleteCrosswalkTemplateById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } }, "patch": { "tags": [ "crosswalk-template-controller" ], "operationId": "patchCrosswalkTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrosswalkTemplatePatchRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CrosswalkTemplateDto" } } } } } } }, "/api/{customerToken}/control-scores/{controlScoreId}/crosswalk-histories": { "get": { "tags": [ "crosswalk-history-controller" ], "operationId": "getControlScoreCrosswalkHistory", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkHistoryAndViewDto" } } } } } } }, "patch": { "tags": [ "crosswalk-history-controller" ], "operationId": "patchCrosswalkHistories", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrosswalkHistoryPatch" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkHistory" } } } } } } } }, "/api/{customerToken}/control-score-actions/{id}": { "patch": { "tags": [ "control-score-action-controller" ], "operationId": "patchControlScoreAction", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlActionPatchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlScoreAction" } } } } } } }, "/api/{customerToken}/control-score-actions/{controlScoreActionId}/control-action-supplemental-scores/{supplementalScoreId}": { "patch": { "tags": [ "control-score-action-controller" ], "operationId": "updateControlActionSupplementalScore", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "supplementalScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlActionSupplementalScore" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlActionSupplementalScore" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/control-score": { "patch": { "tags": [ "control-score-controller" ], "operationId": "patchControlScore", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlScorePatchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlScore" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/control-score/notes": { "patch": { "tags": [ "notes-module-controller" ], "operationId": "updateModule", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModulePatchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NotesModuleEntry" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/control-score/assessor": { "patch": { "tags": [ "assessor-module-controller" ], "operationId": "updateModule_1", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModulePatchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessorModuleEntry" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/control-score-reminder/{controlScoreReminderId}": { "delete": { "tags": [ "control-score-controller" ], "operationId": "deleteControlScoreReminder", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreReminderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "control-score-controller" ], "operationId": "updateControlScoreReminder", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreReminderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlScoreReminderDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlScoreReminderDto" } } } } } } }, "/api/v1/public/control-score-actions/{id}": { "patch": { "tags": [ "Assessment Control Score Actions" ], "operationId": "patchControlScoreAction_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/framework/{frameworkId}/publishFramework": { "patch": { "tags": [ "framework-admin-controller" ], "operationId": "publishFramework", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/admin/framework/{frameworkId}/disableFramework": { "patch": { "tags": [ "framework-admin-controller" ], "operationId": "disableFramework_1", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/admin/environment-settings": { "patch": { "tags": [ "environment-settings-controller" ], "operationId": "upsertEnvironmentSettings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEnvironmentSettingsRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EnvironmentSettings" } } } } } } }, "/api/admin/customers/{id}": { "patch": { "tags": [ "customer-admin-controller" ], "operationId": "patchCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonMergePatch" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Customer" } } } } } } }, "/api/{token}/principals/{id}": { "get": { "tags": [ "principal-controller" ], "operationId": "findPrincipal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PrincipalDto" } } } } } } }, "/api/{token}/assessments/report-templates/{reportId}/fill/{assessmentId}": { "get": { "tags": [ "assessment-report-template-controller" ], "operationId": "fill", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "debug", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/vulnerability-scan-templates": { "get": { "tags": [ "vulnerability-scan-template-controller" ], "operationId": "getCustomerVulnerabilityScanTemplates", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "assessmentId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VulnerabilityScanTemplate" } } } } } } } }, "/api/{customerToken}/vulnerability-scan-templates/{templateId}": { "get": { "tags": [ "vulnerability-scan-template-controller" ], "operationId": "getCustomerVulnerabilityScanTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/VulnerabilityScanTemplate" } } } } } } }, "/api/{customerToken}/vulnerability-scan-templates/{templateId}/entries": { "get": { "tags": [ "vulnerability-scan-template-controller" ], "operationId": "getCustomerVulnerabilityScanTemplateEntrySummaries", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VulnerabilityScanTemplateEntrySummary" } } } } } } } }, "/api/{customerToken}/users": { "get": { "tags": [ "user-controller" ], "operationId": "findAllUsersWithSearch", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "roles[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "organizationalUnits[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "statuses[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "groups[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "controlCompletionStatus", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PAST_DUE", "INCOMPLETE" ] } }, { "name": "selectedIds[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "default": [] } }, { "name": "onlyShowSelected", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "authenticationMethods[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "rootOrganizationalUnitId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAdminUserDto" } } } } } } }, "/api/{customerToken}/users/{userId}": { "get": { "tags": [ "user-controller" ], "operationId": "findAdminDtoUserById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AdminUserDto" } } } } } } }, "/api/{customerToken}/users/{userId}/owned-risks": { "get": { "tags": [ "user-controller" ], "operationId": "getOwnedRisks", "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dashboardList", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "typeList", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "planList", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "sortKey", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sortValue", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageRiskOwnerRiskDashboardDto" } } } } } } }, "/api/{customerToken}/users/{userId}/owned-risks-config": { "get": { "tags": [ "user-controller" ], "operationId": "getOwnedRisksConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/OwnedRisksConfig" } } } } } } }, "/api/{customerToken}/user": { "get": { "tags": [ "user-controller" ], "operationId": "findAllUsers", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminUserDto" } } } } } } } }, "/api/{customerToken}/tenable/authentications/{authId}": { "get": { "tags": [ "tenable-integration-controller" ], "operationId": "getIntegrationAuthentication", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "authId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TenableSourceAuthenticationSecure" } } } } } } }, "/api/{customerToken}/supplemental-score-models": { "get": { "tags": [ "supplemental-score-model-controller" ], "operationId": "getModels", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreModelReturnData" } } } } } } } }, "/api/{customerToken}/snowflake/integration-source-authentications": { "get": { "tags": [ "snowflake-integration-controller" ], "operationId": "getIntegrationAuthentications_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SnowflakeSourceAuthenticationSecure" } } } } } } } }, "/api/{customerToken}/snowflake/integration-source-authentications/{authId}": { "get": { "tags": [ "snowflake-integration-controller" ], "operationId": "getIntegrationAuthentication_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "authId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SnowflakeSourceAuthenticationSecure" } } } } } } }, "/api/{customerToken}/settings/user/qr-code": { "get": { "tags": [ "user-settings-controller" ], "operationId": "findQrCodeNew", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "image/png": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/{customerToken}/score-model": { "get": { "tags": [ "score-model-controller" ], "operationId": "getScoreModels", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ScoreModel" } } } } } } } }, "/api/{customerToken}/score-model-value-set": { "get": { "tags": [ "score-model-controller" ], "operationId": "getScoreModelValueSets_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "frameworkId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreModelValueSetDto" } } } } } } } }, "/api/{customerToken}/score-guidance/set": { "get": { "tags": [ "score-guidance-controller" ], "operationId": "getScoreGuidanceForControlAction", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "frameworkId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlActionId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreGuidance" } } } } } } } }, "/api/{customerToken}/risks/{riskId}/controls": { "get": { "tags": [ "risk-controller" ], "operationId": "controlsForRisk", "parameters": [ { "name": "riskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Control" } } } } } } } }, "/api/{customerToken}/risks/{riskId}/control-scores": { "get": { "tags": [ "risk-controller" ], "operationId": "controlScoresForRisk", "parameters": [ { "name": "riskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWithScoreControlScore" } } } } } } } }, "/api/{customerToken}/risks/{riskId}/ale-over-time": { "get": { "tags": [ "risk-controller" ], "operationId": "getRiskAleOverTime", "parameters": [ { "name": "riskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskAleOverTime" } } } } } } }, "/api/{customerToken}/risks/{id}": { "get": { "tags": [ "risk-controller" ], "operationId": "findRiskById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Risk" } } } } } } }, "/api/{customerToken}/risks/{id}/risk-over-time": { "get": { "tags": [ "risk-controller" ], "operationId": "getRiskOverTime", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OverallRiskStat" } } } } } } } }, "/api/{customerToken}/risks/{id}/mitre-techniques": { "get": { "tags": [ "risk-controller" ], "operationId": "getMitreTechniquesForRisk", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MitreTechniqueDto" } } } } } } } }, "/api/{customerToken}/risks/{id}/control-stats": { "get": { "tags": [ "risk-controller" ], "operationId": "getRiskControlStats", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskControlStat" } } } } } } } }, "/api/{customerToken}/risks/{dashboardId}": { "get": { "tags": [ "risk-controller" ], "operationId": "getAllRisksForDashboard_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Risk" } }, { "type": "array", "items": { "$ref": "#/components/schemas/RiskSummary" } } ] } } } } } } }, "/api/{customerToken}/risks/treatment-plan-options": { "get": { "tags": [ "risk-controller" ], "operationId": "getAllRiskTreatmentOptions", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskTreatmentPlanOption" } } } } } } } }, "/api/{customerToken}/risks/risk-dashboards/{riskDashboardId}/level": { "get": { "tags": [ "risk-controller" ], "operationId": "findRiskModelLegendValueByDashboardImpactLikelihood", "parameters": [ { "name": "riskLevelFilters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RiskLevelFilters" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskDashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskModelLegendValue" } } } } } } }, "/api/{customerToken}/risks/risk-association-config": { "get": { "tags": [ "risk-controller" ], "operationId": "getRiskAssociationConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "validOrganizationalUnitIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskAssociationConfig" } } } } } } }, "/api/{customerToken}/risks/remediation-project-dashboard-summary": { "get": { "tags": [ "risk-controller" ], "operationId": "getRiskRemediationProjectsSummaryByRiskId", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RiskRemediationProjectDashboardFilters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRemediationProjectAndDashboardSummary" } } } } } } }, "/api/{customerToken}/risks/overview/{dashboardId}": { "get": { "tags": [ "risk-controller" ], "operationId": "getRiskOverviewStats", "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filterParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RiskFilterParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskOverviewStats" } } } } } } }, "/api/{customerToken}/risks/impact-summary/{dashboardId}": { "get": { "tags": [ "risk-controller" ], "operationId": "findHeatMap", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "filterParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RiskFilterParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskImpactSummary" } } } } } } } }, "/api/{customerToken}/risks/executive-dashboard/{dashboardId}/risk-summaries": { "get": { "tags": [ "risk-controller" ], "operationId": "getAllRisksForExecutiveDashboard", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutiveDashboardRiskSummary" } } } } } } } }, "/api/{customerToken}/risks/customer-dashboard/risk-summaries": { "get": { "tags": [ "risk-controller" ], "operationId": "getAllRisksForCustomerDashboard", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutiveDashboardRiskSummary" } } } } } } } }, "/api/{customerToken}/risks/bah/{id}/selected-controls": { "get": { "tags": [ "risk-controller" ], "operationId": "getBahRiskSelectedControls", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlIdAndCsfFunctionName" } } } } } } } }, "/api/{customerToken}/risks/bah/{id}/scores": { "get": { "tags": [ "risk-controller" ], "operationId": "getBahRiskScores", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BahRiskScorePopulated" } } } } } } } }, "/api/{customerToken}/risks/bah/categories": { "get": { "tags": [ "risk-controller" ], "operationId": "getAllBahRiskCategories", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BahCategory" } } } } } } } }, "/api/{customerToken}/risks/bah/assessments/{assessmentId}/templates/{templateId}/controls": { "get": { "tags": [ "risk-controller" ], "operationId": "getTemplateSelectedCyberInsightControls", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlCsfFunctions" } } } } } } } }, "/api/{customerToken}/risks/bah/assessment/{assessmentId}/exists": { "get": { "tags": [ "risk-controller" ], "operationId": "checkBahRiskExistsForAssessmentId", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "boolean" } } } } } } }, "/api/{customerToken}/risk-treatment-plans/{riskId}/history": { "get": { "tags": [ "risk-treatment-plan-controller" ], "operationId": "getRiskTreatmentHistory", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskTreatmentPlanHistoryDto" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/{id}/risks": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskRemediationProjectRisks", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRemediation" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/{id}/controls": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskRemediationProjectControls", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Control" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/{id}/control-score-actions": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskControlScoresForRemediationProject", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RemediationControlScoreSummary" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/{id}/control-score-action-target-values": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskRemediationControlScoreActionTargetValues", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreActionTargetSummary" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/{id}/assessments": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskRemediationProjectAssessments", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Assessment" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/statuses": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskRemediationProjectStatusOptions", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRemediationProjectOption" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/risks": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getAllRisksForRemediation_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "riskRemediationAllRisksFilters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RiskRemediationAllRisksFilters" } }, { "name": "params", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RosiComparisonParameters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PageRiskScenarioSummary" }, { "$ref": "#/components/schemas/PageRiskRemediation" } ] } } } } } } }, "/api/{customerToken}/risk-remediation-projects/risks/{riskId}/assessments-control-scores": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getAssessmentsControlScoresControlsForRisk", "parameters": [ { "name": "riskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "remediationDashboardId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageRiskAssociatedAssessmentControlScore" } } } } } } }, "/api/{customerToken}/risk-remediation-projects/project-timeline": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getProjectTimelineSummary", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "params", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RemediationTimelineParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTimelineEntry" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/project-timeline-default-date-range": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getProjectTimelineDefaultDateRange", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "params", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RemediationTimelineParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ProjectTimelineDefaultDateRange" } } } } } } }, "/api/{customerToken}/risk-remediation-projects/priorities": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getRiskRemediationProjectPriorityOptions", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRemediationProjectOption" } } } } } } } }, "/api/{customerToken}/risk-remediation-projects/migrate-customer-projects": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "migrateExistingRemediationProjectsByCustomerIds", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risk-remediation-projects/dashboard/reduction-summary": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getDashboardReductionSummary", "parameters": [ { "name": "params", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RosiComparisonParameters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRemediationDashboardReductionSummary" } } } } } } }, "/api/{customerToken}/risk-remediation-projects/dashboard/overall-summary": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getDashboardOverallSummary", "parameters": [ { "name": "params", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RosiComparisonParameters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRemediationProjectDashboardSummary" } } } } } } }, "/api/{customerToken}/risk-remediation-projects/dashboard/cost-summary": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getDashboardProjectCostSummary", "parameters": [ { "name": "params", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RosiComparisonParameters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRemediationDashboardCostSummary" } } } } } } }, "/api/{customerToken}/risk-remediation-projects/csf-subcategories": { "get": { "tags": [ "risk-remediation-project-controller" ], "operationId": "getGeneralCsfData", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CsfSubcategoryCategoryFunction" } } } } } } } }, "/api/{customerToken}/risk-remediation-dashboards/{id}/summary": { "get": { "tags": [ "risk-remediation-dashboard-controller" ], "operationId": "getRemediationDashboardSummary", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRemediationDashboardSummary" } } } } } } }, "/api/{customerToken}/risk-remediation-dashboards/{id}/assignable-users": { "get": { "tags": [ "risk-remediation-dashboard-controller" ], "operationId": "getAssignableUsers", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminUser" } } } } } } } }, "/api/{customerToken}/risk-remediation-dashboards/summaries": { "get": { "tags": [ "risk-remediation-dashboard-controller" ], "operationId": "getRemediationDashboardSummaries", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RemediationDashboardSummaryFilters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageRiskRemediationDashboardSummary" } } } } } } }, "/api/{customerToken}/risk-registers/{riskRegisterId}/generate/docx": { "get": { "tags": [ "risk-register-controller" ], "operationId": "generateWordDocument", "parameters": [ { "name": "riskRegisterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/risk-registers/{riskRegisterId}/generate/csv": { "get": { "tags": [ "risk-register-controller" ], "operationId": "generateCSV", "parameters": [ { "name": "riskRegisterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/risk-registers/{riskRegisterId}/config": { "get": { "tags": [ "risk-register-controller" ], "operationId": "findRiskDashboardConfig", "parameters": [ { "name": "riskRegisterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRegisterConfig" } } } } } } }, "/api/{customerToken}/risk-registers/{riskRegisterId}/bah": { "get": { "tags": [ "risk-register-controller" ], "operationId": "findBahSummary", "parameters": [ { "name": "riskRegisterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BahRiskSummary" } } } } } } }, "/api/{customerToken}/risk-registers/{riskRegisterId}/assessments": { "get": { "tags": [ "risk-register-controller" ], "operationId": "findAllRiskRegisterAssessments", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskRegisterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Assessment" } } } } } } } }, "/api/{customerToken}/risk-registers/{riskRegisterId}/ale-over-time": { "get": { "tags": [ "risk-register-controller" ], "operationId": "getAleOverTime", "parameters": [ { "name": "riskRegisterId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filterParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RiskFilterParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskAleOverTime" } } } } } } }, "/api/{customerToken}/risk-registers/{riskDashboardId}": { "get": { "tags": [ "risk-register-controller" ], "operationId": "getRiskRegisterDto", "parameters": [ { "name": "riskDashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRegisterDto" } } } } } } }, "/api/{customerToken}/risk-registers/types": { "get": { "tags": [ "risk-register-controller" ], "operationId": "getAllRiskDashboardTypes", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRegisterType" } } } } } } } }, "/api/{customerToken}/risk-registers/summaries": { "get": { "tags": [ "risk-register-controller" ], "operationId": "getRiskRegisterSummaries", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RiskRegisterSummaryFilters" } }, { "name": "selectedRootOrganizationalUnitId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageRiskRegisterSummary" } } } } } } }, "/api/{customerToken}/risk-registers/config": { "get": { "tags": [ "risk-register-controller" ], "operationId": "getRiskRegistersConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationalUnitId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskRegistersConfig" } } } } } } }, "/api/{customerToken}/risk-nist-types/{id}/categories": { "get": { "tags": [ "risk-nist-type-controller" ], "operationId": "getRiskNistCategoriesByTypeId", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskNistCategory" } } } } } } } }, "/api/{customerToken}/risk-nist-types/name/{name}": { "get": { "tags": [ "risk-nist-type-controller" ], "operationId": "getRiskNistTypesByName", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskNistTypeSummary" } } } } } } }, "/api/{customerToken}/risk-nist-types/categories/{categoryId}": { "get": { "tags": [ "risk-nist-type-controller" ], "operationId": "getRiskNistCategoryById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskNistCategory" } } } } } } }, "/api/{customerToken}/risk-models": { "get": { "tags": [ "risk-model-controller" ], "operationId": "getAllRiskModels_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskModelSummaryDto" } } } } } } } }, "/api/{customerToken}/risk-models/{riskModelId}/can-disable": { "get": { "tags": [ "risk-model-controller" ], "operationId": "canDisableRiskModel", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "riskModelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "boolean" } } } } } } }, "/api/{customerToken}/reports/recentlyUpdated": { "get": { "tags": [ "dashboard-metrics-controller" ], "operationId": "findRecentlyUpdated", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } } } } } } } }, "/api/{customerToken}/report/csf": { "get": { "tags": [ "dashboard-metrics-controller" ], "operationId": "findCsfChartsByCustomer", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CsfAndControlFamilyChartsForCustomer" } } } } } } }, "/api/{customerToken}/qualys/authentications/{integrationAuthId}": { "get": { "tags": [ "qualys-integration-controller" ], "operationId": "getIntegrationAuthentication_2", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "integrationAuthId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/QualysSourceAuthenticationSecure" } } } } } }, "delete": { "tags": [ "qualys-integration-controller" ], "operationId": "deleteIntegrationAuthentication_2", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "integrationAuthId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/qualitative-preset-options": { "get": { "tags": [ "qualitative-preset-controller" ], "operationId": "findAllPresetOptions", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualitativePresetOptions" } } } } } } } }, "/api/{customerToken}/qualitative-preset-options/likelihoods/{likelihoodCount}": { "get": { "tags": [ "qualitative-preset-controller" ], "operationId": "findLikelihoodPresetOptions", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "likelihoodCount", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualitativePresetOption" } } } } } } } }, "/api/{customerToken}/qualitative-preset-options/impacts/{impactCount}": { "get": { "tags": [ "qualitative-preset-controller" ], "operationId": "findImpactPresetOptions", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "impactCount", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QualitativePresetOption" } } } } } } } }, "/api/{customerToken}/product-features": { "get": { "tags": [ "product-feature-controller" ], "operationId": "getCustomerProductFeatures", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } } } }, "/api/{customerToken}/posthog": { "get": { "tags": [ "posthog-controller" ], "operationId": "getKey", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PostHogConfigResponse" } } } } } } }, "/api/{customerToken}/postgres/authentications/{authId}": { "get": { "tags": [ "postgres-integration-controller" ], "operationId": "getIntegrationAuthentication_3", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "authId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PostgresSourceAuthenticationSecure" } } } } } } }, "/api/{customerToken}/possible-cyber-insight-risk-template-owners": { "get": { "tags": [ "user-controller" ], "operationId": "findPossibleCyberInsightRiskTemplateOwners", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } } } } } } } }, "/api/{customerToken}/possible-control-owners": { "get": { "tags": [ "user-controller" ], "operationId": "findPossibleControlOwners", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationalUnitId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } } } } } } } }, "/api/{customerToken}/possible-asset-group-owners": { "get": { "tags": [ "user-controller" ], "operationId": "findPossibleAssetGroupOwners", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationalUnitId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } } } } } } } }, "/api/{customerToken}/possible-assessment-owners": { "get": { "tags": [ "user-controller" ], "operationId": "findPossibleAssessmentOwners", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationalUnitId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } } } } } } } }, "/api/{customerToken}/possible-800-30-risk-template-owners": { "get": { "tags": [ "user-controller" ], "operationId": "findPossible80030RiskTemplateOwners", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } } } } } } } }, "/api/{customerToken}/possible-800-30-risk-owners": { "get": { "tags": [ "user-controller" ], "operationId": "findPossible80030RiskOwners", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationalUnitId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } } } } } } } }, "/api/{customerToken}/policy-templates/{policyTemplateId}/integration-mappings": { "get": { "tags": [ "integration-controller" ], "operationId": "getCustomerMappingsSummaryForPolicyTemplate", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "policyTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlToPoliciesSummary" } } } } } } } }, "/api/{customerToken}/ping": { "get": { "tags": [ "ping-controller" ], "operationId": "pingCustomer", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/api/{customerToken}/permissions": { "get": { "tags": [ "permission-controller" ], "operationId": "getAllPermissions", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } } } } } }, "/api/{customerToken}/permissions-summary": { "get": { "tags": [ "permission-controller" ], "operationId": "getPermissionSummary", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PermissionSummary" } } } } } } }, "/api/{customerToken}/permissions-structure": { "get": { "tags": [ "permission-controller" ], "operationId": "getPermissionStructure", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionGroup" } } } } } } } }, "/api/{customerToken}/organizational-units/{id}/roles": { "get": { "tags": [ "role-controller" ], "operationId": "getRolesForOrganizationalUnit", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } } } } } } } }, "/api/{customerToken}/organizational-units/{id}/content-summary": { "get": { "tags": [ "organizational-unit-controller" ], "operationId": "getContentSummary", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/OrganizationalUnitContentSummary" } } } } } } }, "/api/{customerToken}/organizational-unit-tree": { "get": { "tags": [ "organizational-unit-controller" ], "operationId": "getOrganizationalUnitTree", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationalUnitId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/OrganizationalUnitTreeNode" } } } } } } }, "/api/{customerToken}/notifications/knight-vision": { "get": { "tags": [ "notification-controller" ], "operationId": "getKnightVisionSubscriptions", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnightVisionSubscription" } } } } } } } }, "/api/{customerToken}/nist-800-30-risks/{id}/controls": { "get": { "tags": [ "risk-controller" ], "operationId": "findRiskNist80030ControlAndScores", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RiskNist80030ControlAndScores" } } } } } } }, "/api/{customerToken}/nist-800-30-risk-templates/{id}/summary": { "get": { "tags": [ "nist-80030-risk-template-controller" ], "operationId": "getNist80030RiskTemplateSummaryById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Nist80030RiskTemplateSummary" } } } } } } }, "/api/{customerToken}/nist-800-30-risk-templates/statuses": { "get": { "tags": [ "nist-80030-risk-template-controller" ], "operationId": "getNist80030RiskTemplateStatus", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Nist80030RiskTemplateStatus" } } } } } } } }, "/api/{customerToken}/mitre/tactics": { "get": { "tags": [ "mitre-controller" ], "operationId": "getMitreTacticAndTechniques", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MitreTacticXTechnique" } } } } } } } }, "/api/{customerToken}/maturity/models": { "get": { "tags": [ "maturity-controller" ], "operationId": "findMaturityModels", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaturityModel" } } } } } } } }, "/api/{customerToken}/maturity/models/{maturityModel}": { "get": { "tags": [ "maturity-controller" ], "operationId": "findMaturityModelScores", "parameters": [ { "name": "maturityModel", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaturityScore" } } } } } } } }, "/api/{customerToken}/maturity-models": { "get": { "tags": [ "maturity-model-controller" ], "operationId": "getMaturityModels", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaturityModel" } } } } } } } }, "/api/{customerToken}/manage/tags": { "get": { "tags": [ "assessment-tag-management-controller" ], "operationId": "findAllTagTagGroupAssessments", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filterParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/TagTagGroupAssessmentFilterParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagTagGroupAssessments" } } } } } } } }, "/api/{customerToken}/manage/framework/available": { "get": { "tags": [ "framework-management-controller" ], "operationId": "getAvailableFrameworks", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableFrameworksResponse" } } } } } } } }, "/api/{customerToken}/manage/assessments/{assessmentId}": { "get": { "tags": [ "assessment-management-controller" ], "operationId": "findAssessmentTagGroupSelections", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentTagGroupSelectionDto" } } } } } } } }, "/api/{customerToken}/manage/assessment/{assessmentId}/control-score/config": { "get": { "tags": [ "assessment-management-controller" ], "operationId": "findControlScoreConfig", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlScoreConfigResponse" } } } } } } }, "/api/{customerToken}/loggedInUser": { "get": { "tags": [ "current-user-controller" ], "operationId": "getCurrentUser", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/LoggedInUser" } } } } } } }, "/api/{customerToken}/integration-sources": { "get": { "tags": [ "integration-controller" ], "operationId": "getCustomerIntegrationSources", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "enabledOnly", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationSource" } } } } } } } }, "/api/{customerToken}/integration-sources/{sourceId}": { "get": { "tags": [ "integration-controller" ], "operationId": "getCustomerIntegrationSource", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/IntegrationSource" } } } } } } }, "/api/{customerToken}/integration-sources/{sourceId}/policies": { "get": { "tags": [ "integration-controller" ], "operationId": "getCustomerIntegrationPoliciesForSource", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationPolicy" } } } } } } } }, "/api/{customerToken}/ibm/locations": { "get": { "tags": [ "ibm-integration-controller" ], "operationId": "getLocations", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IbmLocationDto" } } } } } } } }, "/api/{customerToken}/ibm/integration-source-authentications": { "get": { "tags": [ "ibm-integration-controller" ], "operationId": "getIntegrationAuthentications_4", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IbmSourceAuthenticationSecure" } } } } } } } }, "/api/{customerToken}/ibm/integration-source-authentications/{authId}": { "get": { "tags": [ "ibm-integration-controller" ], "operationId": "getIntegrationAuthentication_4", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "authId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/IbmSourceAuthenticationSecure" } } } } } } }, "/api/{customerToken}/ibm/authentications/{integrationAuthId}/instances": { "get": { "tags": [ "ibm-integration-controller" ], "operationId": "getInstances", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "integrationAuthId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IbmInstance" } } } } } } } }, "/api/{customerToken}/ibm/authentications/{integrationAuthId}/instances/{instanceId}/attachments": { "get": { "tags": [ "ibm-integration-controller" ], "operationId": "getAttachments", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "integrationAuthId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "instanceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IbmAttachment" } } } } } } } }, "/api/{customerToken}/groups/{groupId}/possible-users": { "get": { "tags": [ "user-controller" ], "operationId": "findAllPossibleGroupUsers", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "organizationalUnits[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "statuses[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "selectedIds[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "default": [] } }, { "name": "onlyShowSelected", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAdminUserDto" } } } } } } }, "/api/{customerToken}/governance-dashboards/{dashboardId}/widgets/{widgetId}/history": { "get": { "tags": [ "governance-dashboard-widget-controller" ], "operationId": "getChartHistory", "parameters": [ { "name": "widgetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CSFOverTimeWidget" } } } } } } }, "/api/{customerToken}/governance-dashboards/{dashboardId}/widgets/config": { "get": { "tags": [ "governance-dashboard-widget-controller" ], "operationId": "findWidgetConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GovernanceDashboardWidgetConfig" } } } } } } }, "/api/{customerToken}/frameworks/{id}": { "get": { "tags": [ "framework-controller" ], "operationId": "findFrameworkById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Framework" } } } } } } }, "/api/{customerToken}/frameworks/{id}/score-model": { "get": { "tags": [ "framework-controller" ], "operationId": "findFrameworkScoreModel", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ScoreModel" } } } } } } }, "/api/{customerToken}/frameworks/{frameworkId}": { "get": { "tags": [ "framework-controller" ], "operationId": "findFrameworkAndControlsDtoById", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeParents", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAndControlsDto" } } } } } } }, "/api/{customerToken}/frameworks/{frameworkId}/integration-control-entries/": { "get": { "tags": [ "integration-controller" ], "operationId": "getCustomerIntegrationControlEntries", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationControlEntry" } } } } } } } }, "/api/{customerToken}/frameworks/{frameworkId}/assessments/{assessmentId}/metadata": { "get": { "tags": [ "assessment-metadata-controller" ], "operationId": "findAssessmentMetadataFieldDtos", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentMetadataFieldDto" } } } } } } } }, "/api/{customerToken}/frameworks/search-metadata": { "get": { "tags": [ "framework-controller" ], "operationId": "searchFrameworksMetadata", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkSearchMetadata" } } } } } } }, "/api/{customerToken}/framework/{frameworkId}/score-guidance": { "get": { "tags": [ "score-guidance-controller" ], "operationId": "getControlActionsWithScoreGuidance", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlActionScoreGuidance" } } } } } } } }, "/api/{customerToken}/framework-restricted-features-map": { "get": { "tags": [ "framework-configuration-controller" ], "operationId": "getFrameworkRestrictedFeaturesMap", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "enum": [ "CURRENT_SCORE", "TARGET_SCORE" ] } } } } } } } } }, "/api/{customerToken}/framework-configurations/{frameworkId}": { "get": { "tags": [ "framework-configuration-controller" ], "operationId": "getFrameworkConfiguration", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkConfiguration" } } } } } } }, "/api/{customerToken}/framework-config-definitions": { "get": { "tags": [ "framework-config-definition-controller" ], "operationId": "getConfigDefinition", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkConfigDefinition" } } } } } } }, "/api/{customerToken}/findings": { "get": { "tags": [ "finding-controller" ], "operationId": "getCustomerFindingDtos", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FindingDto" } } } } } } } }, "/api/{customerToken}/feature-restrictions/exists": { "get": { "tags": [ "framework-configuration-controller" ], "operationId": "featureRestriction_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "frameworkId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "configFeatureKey", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "CURRENT_SCORE", "TARGET_SCORE" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "boolean" } } } } } } }, "/api/{customerToken}/feature-flags": { "get": { "tags": [ "feature-flag-controller" ], "operationId": "getFeatureFlags", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureFlag" } } } } } } } }, "/api/{customerToken}/fair-risks/{id}/controls/control-score-changes": { "get": { "tags": [ "fair-risk-controller" ], "operationId": "findControlControlScoreChanges", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWithControlScoreChanges" } } } } } } } }, "/api/{customerToken}/fair-risks/{id}/control-score-changes": { "get": { "tags": [ "fair-risk-controller" ], "operationId": "findControlScoreChanges", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreChanges" } } } } } } } }, "/api/{customerToken}/fair-risk-dashboards/{dashboardId}/metamodel": { "get": { "tags": [ "fair-risk-controller" ], "operationId": "findFairRiskDashboardMetamodel", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dashboardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FairRiskMetaModel" } } } } } } }, "/api/{customerToken}/executive-dashboards/{id}/risks": { "get": { "tags": [ "executive-dashboard-controller" ], "operationId": "findAllExecutiveDashboardRisksByCategory", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "onlyTop5Categories", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RisksByCategory" } } } } } } } }, "/api/{customerToken}/executive-dashboard/{id}/csf-maturity": { "get": { "tags": [ "executive-dashboard-controller" ], "operationId": "getCsfMaturity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExecutiveDashboardCsfMaturityDto" } } } } } } }, "/api/{customerToken}/environment-settings": { "get": { "tags": [ "environment-settings-controller" ], "operationId": "findEnvironmentSettings", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EnvironmentSettings" } } } } } } }, "/api/{customerToken}/defaultNotifications": { "get": { "tags": [ "notification-controller" ], "operationId": "getDefaultCatalog", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "enum": [ "CONTROL_SCORE_CHANGED", "CONTROL_ASSIGNED", "NOTE_ADDED", "EVIDENCE_ADDED", "WORKFLOW_CHANGED" ] } } } } } } } }, "/api/{customerToken}/data-lake-templates/{templateId}/entries": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getCustomerDataLakeTemplateEntries", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeEntriesDto" } } } } } } } }, "/api/{customerToken}/data-lake-templates/{templateId}/entries/templated": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getCustomerDataLakeTemplateEntriesTemplated", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeEntriesTemplatedDto" } } } } } } } }, "/api/{customerToken}/data-lake-templates/{templateId}/entries/ad-hoc": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getCustomerDataLakeTemplateEntriesAdHoc", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeEntriesAdHocDto" } } } } } } } }, "/api/{customerToken}/cyber-insight-templates/{templateId}": { "get": { "tags": [ "cyber-insight-template-controller" ], "operationId": "findCyberInsightTemplateWithAnswers", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assessmentId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CyberInsightTemplateAnswersDto" } } } } } } }, "/api/{customerToken}/cyber-insight-templates/{templateId}/controls": { "get": { "tags": [ "cyber-insight-template-controller" ], "operationId": "findAllControlAndCsfFunctionsDtoByTemplateId", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlFrameworkAndCsfFunctionsDto" } } } } } } } }, "/api/{customerToken}/customer/{customerId}": { "get": { "tags": [ "customer-controller" ], "operationId": "findById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Customer" } } } } } } }, "/api/{customerToken}/customer/public-config": { "get": { "tags": [ "customer-controller" ], "operationId": "getConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CustomerConfig" } } } } } } }, "/api/{customerToken}/customer/auth/saml/certificate": { "get": { "tags": [ "customer-controller" ], "operationId": "getPublicSamlCert", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/custom-reports/{reportId}/preview": { "get": { "tags": [ "custom-report-controller" ], "operationId": "getReportPreview", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CustomReportPreviewDto" } } } } } } }, "/api/{customerToken}/custom-reports/{reportId}/csv": { "get": { "tags": [ "custom-report-controller" ], "operationId": "getReportCsv", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/custom-reports/{reportId}/available-fields": { "get": { "tags": [ "custom-report-controller" ], "operationId": "getAvailableFields", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomReportFieldDto" } } } } } } } }, "/api/{customerToken}/custom-reports/{reportId}/assessment-report": { "get": { "tags": [ "custom-report-controller" ], "operationId": "getAssessmentReportMetadataFields", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkIdAndMetadataFieldIdDto" } } } } } } } }, "/api/{customerToken}/custom-reports/types": { "get": { "tags": [ "custom-report-controller" ], "operationId": "getCustomReportTypes", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomReportType" } } } } } } } }, "/api/{customerToken}/csf-functions": { "get": { "tags": [ "csf-admin-controller" ], "operationId": "findAllCsfFunctions", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "csfFramework11Only", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CsfFunction" } } } } } } } }, "/api/{customerToken}/crosswalk-mappings": { "get": { "tags": [ "crosswalk-mapping-controller" ], "operationId": "findAllCrosswalkMappingFullDtosByIds_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ids", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fromFrameworkId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "toFrameworkId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkMapping" } }, { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkMappingFullDto" } } ] } } } } } } }, "/api/{customerToken}/crosswalk-histories": { "get": { "tags": [ "crosswalk-history-controller" ], "operationId": "getControlScoreCrosswalkHistories", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreIds[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkHistory" } } } } } } } }, "/api/{customerToken}/controls": { "get": { "tags": [ "control-controller" ], "operationId": "findAllControlFrameworkAndCsfFunctionDtos", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filterParams", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ControlAndCsfFunctionFilterParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageControlFrameworkAndCsfFunctionsDto" } } } } } } }, "/api/{customerToken}/controls/{id}": { "get": { "tags": [ "control-controller" ], "operationId": "findControlById", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Control" } } } } } } }, "/api/{customerToken}/control-search-config": { "get": { "tags": [ "control-controller" ], "operationId": "findControlSearchConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "frameworkType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "Regulatory", "Binary" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlSearchConfig" } } } } } } }, "/api/{customerToken}/control-scores/{controlScoreId}": { "get": { "tags": [ "control-score-controller" ], "operationId": "getControlScore", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlScore" } } } } } } }, "/api/{customerToken}/control-scores/{controlScoreId}/status": { "get": { "tags": [ "control-score-controller" ], "operationId": "getControlScoreStatus", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlScoreStatus" } } } } } } }, "/api/{customerToken}/control-scores/{controlScoreId}/integration-sources": { "get": { "tags": [ "integration-controller" ], "operationId": "findAllIntegrationSourceDtosByControlScoreId", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreActionIntegrationDto" } } } } } } } }, "/api/{customerToken}/control-scores/{controlScoreId}/evidences": { "get": { "tags": [ "control-score-controller" ], "operationId": "getControlScoreEvidences", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Evidence" } } } } } } } }, "/api/{customerToken}/control-scores/{controlScoreId}/evidences/{evidenceId}": { "get": { "tags": [ "control-score-controller" ], "operationId": "getEvidence", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "evidenceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Evidence" } } } } } } }, "/api/{customerToken}/control-scores/{controlScoreId}/control-score-actions": { "get": { "tags": [ "control-score-controller" ], "operationId": "findAllControlActionAndScoreDtosByControlScoreId", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlActionAndScoreDto" } } } } } } } }, "/api/{customerToken}/control-scores/{controlScoreId}/control-action-supplemental-scores": { "get": { "tags": [ "control-score-controller" ], "operationId": "findAllSupplementalScoresByControlScoreId", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlActionSupplementalScore" } } } } } } } }, "/api/{customerToken}/control-scores/{controlScoreId}/collaborators": { "get": { "tags": [ "control-score-controller" ], "operationId": "getExCollaborators", "parameters": [ { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentUserDto" } } } } } } } }, "/api/{customerToken}/control-scores/{controlScoreId}/annotations": { "get": { "tags": [ "control-score-action-controller" ], "operationId": "findAllControlScoreAnnotations", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreActionAndAnnotation" } } } } } } } }, "/api/{customerToken}/control-score-details-config/{userId}": { "get": { "tags": [ "control-score-controller" ], "operationId": "findControlScoreDetailsConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ControlScoreDetailsConfig" } } } } } } }, "/api/{customerToken}/control-score-actions/{controlScoreActionId}/has-current-score": { "get": { "tags": [ "control-score-action-controller" ], "operationId": "hasControlScoreActionCurrentScore", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "controlScoreActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "boolean" } } } } } } }, "/api/{customerToken}/control-action/search": { "get": { "tags": [ "control-action-controller" ], "operationId": "searchControlActions", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "excludeControlActions[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "frameworks[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageControlSearchResult" } } } } } } }, "/api/{customerToken}/connectors/{id}/fields": { "get": { "tags": [ "connector-controller" ], "operationId": "getConnectorFields", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorField" } } } } } } } }, "/api/{customerToken}/connectors/schema": { "get": { "tags": [ "connector-controller" ], "operationId": "schema", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dataSourceId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SchemaConfig" } } } } } } }, "/api/{customerToken}/connector-stats": { "get": { "tags": [ "connector-controller" ], "operationId": "getConnectorStats", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorStats" } } } } } } } }, "/api/{customerToken}/configuration/control-workflow-definitions": { "get": { "tags": [ "control-workflow-definition-configuration-controller" ], "operationId": "getWorkflowGroupDefinitions", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupNameFilter", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWorkflowGroupDefinitionWithOptions" } } } } } } } }, "/api/{customerToken}/basic-users": { "get": { "tags": [ "user-controller" ], "operationId": "searchBasicUsers", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "active", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } } } } } } } }, "/api/{customerToken}/basic-users/{userId}": { "get": { "tags": [ "user-controller" ], "operationId": "findById_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BasicUserDto" } } } } } } }, "/api/{customerToken}/azure/integration-source-authentications": { "get": { "tags": [ "azure-integration-controller" ], "operationId": "getIntegrationAuthentications_5", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AzureSourceAuthenticationSecure" } } } } } } } }, "/api/{customerToken}/azure/integration-source-authentications/{authId}": { "get": { "tags": [ "azure-integration-controller" ], "operationId": "getIntegrationAuthentication_5", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "authId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AzureSourceAuthenticationSecure" } } } } } } }, "/api/{customerToken}/azure/authentications/{integrationAuthId}/automation-targets": { "get": { "tags": [ "azure-integration-controller" ], "operationId": "getAutomationTargetsBasedOnAuthentication", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "integrationAuthId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AzureIntegrationTargetOptions" } } } } } } }, "/api/{customerToken}/aws/authentications/{authId}": { "get": { "tags": [ "aws-integration-controller" ], "operationId": "getIntegrationAuthentication_6", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "authId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AwsSourceAuthentication" } } } } } } }, "/api/{customerToken}/automation-vulnerability-scan-history/recent/assessments/{assessmentId}/control-scores/{controlActionId}/sources/{sourceId}": { "get": { "tags": [ "automation-history-controller" ], "operationId": "getAutomationVulnerabilityScanHistoryForControlScoreAction", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "months", "in": "query", "required": false, "schema": { "type": "string", "default": "3" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AutomationVulnerabilityScanHistoryDto" } } } } } } }, "/api/{customerToken}/automation-policy-history/recent/assessments/{assessmentId}/control-scores/{controlActionId}/sources/{sourceId}": { "get": { "tags": [ "automation-history-controller" ], "operationId": "getAutomationPolicyHistoryForControlScoreAction", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "months", "in": "query", "required": false, "schema": { "type": "string", "default": "3" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AutomationPoliciesHistoryDto" } } } } } } }, "/api/{customerToken}/automation-details": { "get": { "tags": [ "integration-controller" ], "operationId": "getPaginatedAutomationDetails", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AutomationSummaryFilters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAutomationDetails" } } } } } } }, "/api/{customerToken}/authentication-methods/{authenticationMethodId}/users": { "get": { "tags": [ "user-controller" ], "operationId": "findAllAuthenticationMethodUsersWithSearch", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "authenticationMethodId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "statuses[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAdminUserDto" } } } } } } }, "/api/{customerToken}/audit-logs": { "get": { "tags": [ "audit-log-controller" ], "operationId": "findAuditLogs", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "queryParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AuditLogQueryParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAuditLogDto" } } } } } } }, "/api/{customerToken}/audit-logs-config": { "get": { "tags": [ "audit-log-controller" ], "operationId": "findAuditLogsConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AuditLogsConfig" } } } } } } }, "/api/{customerToken}/asset-groups/{assetGroupId}/risks": { "get": { "tags": [ "asset-group-controller" ], "operationId": "findAssetGroupRisks", "parameters": [ { "name": "assetGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageRiskSummaryDto" } } } } } } }, "/api/{customerToken}/asset-groups/{assetGroupId}/controls": { "get": { "tags": [ "asset-group-controller" ], "operationId": "findAssetGroupControls", "parameters": [ { "name": "assetGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreDetailsDto" } } } } } } } }, "/api/{customerToken}/asset-groups/{assetGroupId}/asset-attributes": { "get": { "tags": [ "asset-group-controller" ], "operationId": "findAssetGroupAssetAttributes", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAssetAttributeEntryDto" } } } } } } }, "/api/{customerToken}/asset-groups/{assetGroupId}/asset-attributes/favorites": { "get": { "tags": [ "asset-group-controller" ], "operationId": "findFavoriteAssetAttributeEntriesForAssetGroup", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assetGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetAttributeEntryDto" } } } } } } } }, "/api/{customerToken}/asset-attributes/list-options": { "get": { "tags": [ "asset-attribute-controller" ], "operationId": "findAllAssetAttributeListOptions", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetAttributeListOption" } } } } } } } }, "/api/{customerToken}/assessments/{id}/connectors": { "get": { "tags": [ "connector-controller" ], "operationId": "getAssessmentConnectors", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Connector" } } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}": { "get": { "tags": [ "assessment-controller" ], "operationId": "findAssessmentById_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AssessmentDto" }, { "$ref": "#/components/schemas/Assessment" } ] } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/status": { "get": { "tags": [ "assessment-controller" ], "operationId": "findAssessmentStatus", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentStatus" } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/metadata": { "get": { "tags": [ "assessment-metadata-controller" ], "operationId": "findAssessmentMetadata", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentMetadataFieldValue" } } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/export": { "get": { "tags": [ "assessment-controller" ], "operationId": "exportAssessment", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/csf-functions": { "get": { "tags": [ "assessment-controller" ], "operationId": "getAssessmentCsfFunctions", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CsfFunction" } } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/crosswalk-histories": { "get": { "tags": [ "assessment-controller" ], "operationId": "findAllAssessmentCrosswalkHistories", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "queryFilters", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CrosswalkHistoryQueryFilters" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkHistory" } } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/controls": { "get": { "tags": [ "assessment-controller" ], "operationId": "findAllControlsByAssessmentIdWithCsfFunction", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlAndCsfFunctionDto" } } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/control-workflow-options": { "get": { "tags": [ "assessment-controller" ], "operationId": "getControlWorkflowOptions", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWorkflowOptionDefinition" } } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/control-scores/{controlScoreId}/modules": { "get": { "tags": [ "assessment-controller" ], "operationId": "getAssessmentControlScoreModules", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AssessmentModuleEntry" } } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/control-actions/{controlActionId}/sources/{sourceId}/history": { "get": { "tags": [ "automation-history-controller" ], "operationId": "getAutomationDataLakeControlActionPolicyHistory", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "policyId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "months", "in": "query", "required": false, "schema": { "type": "string", "default": "3" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AutomationDataLakeControlActionResults" } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/control-actions/{controlActionId}/sources/{sourceId}/data-lake-results": { "get": { "tags": [ "automation-history-controller" ], "operationId": "getAutomationDataLakeControlActionResults", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AutomationDataLakeControlActionResults" } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/control-actions/{controlActionId}/sources/{sourceId}/assets": { "get": { "tags": [ "automation-history-controller" ], "operationId": "getAutomationDataLakeControlActionPolicyAssets2", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "policyId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeScrapeAssetHistoryEntryDto" } } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/automations": { "get": { "tags": [ "assessment-controller" ], "operationId": "getAutomationConfigurationForAssessment", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AutomatedAssessmentDefinitionAndPartsDto" } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/automation-status": { "get": { "tags": [ "integration-controller" ], "operationId": "getAssessmentAutomationDetails", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "enum": [ "Scheduled", "Running", "Paused" ] } } } } } } }, "/api/{customerToken}/assessments/{assessmentId}/assessment-workflow": { "get": { "tags": [ "assessment-controller" ], "operationId": "getAssessmentWorkflow", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentWorkflowGroup" } } } } } } }, "/api/{customerToken}/assessments/summary": { "get": { "tags": [ "assessment-controller" ], "operationId": "assessmentSummary", "parameters": [ { "name": "frameworks", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "csfFrameworks[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "maturityModels[]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "owners", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "workflows", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "riskDashboardId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "onlyShowSelected", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "selectedIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "organizationalUnits", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "selectedOrganizationalUnitId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "executiveDashboardId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAssessmentSummary" } } } } } } }, "/api/{customerToken}/assessments/summary-config": { "get": { "tags": [ "assessment-controller" ], "operationId": "assessmentSummaryConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentSummaryConfig" } } } } } } }, "/api/{customerToken}/assessments/customer-summary": { "get": { "tags": [ "assessment-controller" ], "operationId": "assessmentCustomerSummary", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CustomerAssessmentSummary" } } } } } } }, "/api/{customerToken}/assessments/content": { "get": { "tags": [ "assessment-report-controller" ], "operationId": "generateAssessmentCSV", "parameters": [ { "name": "frameworks", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "maturityModels", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "owners", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "workflows", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "organizationalUnits", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/reports": { "get": { "tags": [ "report-controller" ], "operationId": "getReportTypesForAssessment", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTypeGroups" } } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/reports/threat-types": { "get": { "tags": [ "dashboard-metrics-controller" ], "operationId": "getThreatTypeMetrics", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Report" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/reports/ssp": { "get": { "tags": [ "report-controller" ], "operationId": "getSSPReport", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "config", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/SSPWordConfig" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/reports/ssp-ca": { "get": { "tags": [ "report-controller" ], "operationId": "getSSPCAReport", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "config", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/SSPWordConfig" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/reports/poam-ca": { "get": { "tags": [ "report-controller" ], "operationId": "getPOAMCAReport", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "includeNaControls", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "includeNaControlActions", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "target_scores", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/assessment/{assessmentId}/reports/data-protection": { "get": { "tags": [ "dashboard-metrics-controller" ], "operationId": "getDataProtectionMetrics", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Report" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/reports/complianceScore": { "get": { "tags": [ "dashboard-metrics-controller" ], "operationId": "getComplianceScoreMetrics", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/reports/cmmc-ssp-ca": { "get": { "tags": [ "report-controller" ], "operationId": "getCMMCSSPCAReport", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "na_controls", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/assessment/{assessmentId}/reports/business-impact": { "get": { "tags": [ "dashboard-metrics-controller" ], "operationId": "getBusinessImpactMetrics", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Report" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/report/csf": { "get": { "tags": [ "dashboard-metrics-controller" ], "operationId": "findCsfCharts_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CsfAndControlFamilyChartsForAssessment" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/{projectId}/ssp": { "get": { "tags": [ "assessment-report-controller" ], "operationId": "generateSSPForProject", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/{projectId}/risk-assessment": { "get": { "tags": [ "assessment-report-controller" ], "operationId": "generateRiskAssessmentForProject", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/{projectId}/poam": { "get": { "tags": [ "assessment-report-controller" ], "operationId": "generatePoamForProject", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/vendor": { "get": { "tags": [ "report-controller" ], "operationId": "getAssessmentVendorPDF", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/ssp": { "get": { "tags": [ "assessment-report-controller" ], "operationId": "generateSSP", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/risk-assessment": { "get": { "tags": [ "assessment-report-controller" ], "operationId": "generateRiskAssessment", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "includeNAControls", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/poam": { "get": { "tags": [ "assessment-report-controller" ], "operationId": "generatePoam", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeNaControls", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "target_scores", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/nist-csf-risk-maturity-scoring-workbook": { "get": { "tags": [ "report-controller" ], "operationId": "getNistCsfRiskMaturityScoringWorkbook", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/gdpr": { "get": { "tags": [ "report-controller" ], "operationId": "getAssessmentGDPRPDF", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "includeNaControls", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "includeNaControlActions", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/exec-risk": { "get": { "tags": [ "assessment-report-controller" ], "operationId": "generateExecutiveRiskReport", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/csf": { "get": { "tags": [ "assessment-report-controller" ], "operationId": "generateCSFWord", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/csf-pdf": { "get": { "tags": [ "report-controller" ], "operationId": "getAssessmentCSFPDF", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/csf-excel": { "get": { "tags": [ "assessment-report-controller" ], "operationId": "generateCSFExcel", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/assessment-summary": { "get": { "tags": [ "assessment-report-controller" ], "operationId": "generateAssessmentSummaryReport", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeNAControls", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/assessment-ssp": { "get": { "tags": [ "report-controller" ], "operationId": "getAssessmentSSPPDF", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "includeNaControls", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "includeNaControlActions", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/download/assessment-poam": { "get": { "tags": [ "report-controller" ], "operationId": "getAssessmentPOAMPDF", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeNaControls", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "fully_compliant", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "evidence_required", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "remediation_required", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/{customerToken}/assessment/{assessmentId}/control-score/{controlScoreId}/control-score-reminders": { "get": { "tags": [ "control-score-controller" ], "operationId": "getControlScoreReminders", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreReminderDto" } } } } } } } }, "/api/{customerToken}/assessment-workflow-groups": { "get": { "tags": [ "assessment-workflow-controller" ], "operationId": "getAssessmentWorkflowsForCustomer", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentWorkflowGroup" } } } } } } } }, "/api/{customerToken}/assessment-workflow-groups/{assessmentWorkflowId}": { "get": { "tags": [ "assessment-workflow-controller" ], "operationId": "getAssessmentWorkflowById", "parameters": [ { "name": "assessmentWorkflowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentWorkflowGroup" } } } } } }, "delete": { "tags": [ "assessment-workflow-controller" ], "operationId": "deleteAssessmentWorkflow", "parameters": [ { "name": "assessmentWorkflowId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/assessment-workflow-groups/summary": { "get": { "tags": [ "assessment-workflow-controller" ], "operationId": "getAssessmentWorkflowSummary", "parameters": [ { "name": "workflowNameFilter", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentWorkflowDto" } } } } } } } }, "/api/{customerToken}/assessment-automation-summaries/{assessmentId}": { "get": { "tags": [ "integration-controller" ], "operationId": "getAssessmentAutomationSummary", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AutomatedAssessmentDefinitionSummary" } } } } } } }, "/api/{customerToken}/advisen/sectors": { "get": { "tags": [ "advisen-controller" ], "operationId": "getSectors", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdvisenSectorDto" } } } } } } } }, "/api/{customerToken}/advisen/related-controls": { "get": { "tags": [ "advisen-controller" ], "operationId": "getRelatedControls", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } }, { "name": "filterParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/RelatedControlFilterParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageRelatedSp80053ControlAndRisks" } } } } } } }, "/api/{customerToken}/advisen/related-controls-config": { "get": { "tags": [ "advisen-controller" ], "operationId": "getRelatedControlsConfig", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RelatedControlsConfig" } } } } } } }, "/api/{customerToken}/advisen/loss-counts": { "get": { "tags": [ "advisen-controller" ], "operationId": "findAllLossCountsByFields", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advisenLossCountsQueryParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AdvisenLossCountsQueryParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AdvisenLossCounts" } } } } } } }, "/api/{customerToken}/advisen/attack-vectors": { "get": { "tags": [ "advisen-controller" ], "operationId": "getAttackVectors", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdvisenAttackVector" } } } } } } } }, "/api/v1/public/risks": { "get": { "tags": [ "Risks" ], "summary": "Retrieve risks", "operationId": "findAll", "parameters": [ { "name": "includeControls", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "page", "in": "query", "description": "Zero based page to retrieve" }, { "name": "size", "in": "query", "description": "Size of the page to retrieve. When the includeControls parameter is included and set to true, size will be restricted to a maximum value of 10 due to payload size considerations." } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageRiskResponseV1" } } } } } } }, "/api/v1/public/risks/{id}": { "get": { "tags": [ "Risks" ], "summary": "Retrieve risk by id", "operationId": "findRisk", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "includeControls", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CyberInsightRiskResponseV1" }, { "$ref": "#/components/schemas/FairRiskResponseV1" }, { "$ref": "#/components/schemas/NistRiskResponseV1" } ] } } } } } } }, "/api/v1/public/risks/{id}/control-scores": { "get": { "tags": [ "Risks" ], "summary": "Retrieve all control scores associated with a risk", "operationId": "findRiskControlScores", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScorePublicDtoV1" } } } } } } } }, "/api/v1/public/risk-dashboards": { "get": { "tags": [ "Risk-Dashboards" ], "summary": "Find all risk dashboards in customer environment", "operationId": "findAll_1", "parameters": [ { "name": "page", "in": "query", "description": "Zero based page to retrieve" }, { "name": "size", "in": "query", "description": "Size of the page to retrieve" }, { "name": "sort", "in": "query", "description": "Sort the results based one or more fields", "schema": { "type": "string", "enum": [ "name,desc", "name,asc" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageRiskDashboardResponseV1" } } } } } } }, "/api/v1/public/risk-dashboards/{id}/risks": { "get": { "tags": [ "Risk-Dashboards" ], "operationId": "findRisks", "parameters": [ { "name": "created.gte", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "updated.gte", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "includeControls", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "description": "Zero based page to retrieve" }, { "name": "size", "in": "query", "description": "Size of the page to retrieve" } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageRiskResponseV1" } } } } } } }, "/api/v1/public/frameworks/{frameworkId}": { "get": { "tags": [ "Frameworks" ], "operationId": "getFrameworkById", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkPublicDtoV1" } } } } } } }, "/api/v1/public/frameworks/{frameworkId}/score-model": { "get": { "tags": [ "Frameworks" ], "summary": "Retrieve the score model with values that the framework is configured with", "operationId": "getScoreModel", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ScoreModelPublicDtoV1" } } } } } } }, "/api/v1/public/frameworks/{frameworkId}/metadata-fields": { "get": { "tags": [ "Frameworks" ], "summary": "Retrieve all the configured metadata fields for a framework", "operationId": "findMetadataFields", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkMetadataFieldResponseV1" } } } } } } }, "/api/v1/public/frameworks/{frameworkId}/controls": { "get": { "tags": [ "Frameworks" ], "summary": "Retrieve all controls for a framework. If the framework displays control actions then controls will include their control actions", "operationId": "getControlsByFrameworkId", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "description": "Zero based page to retrieve" }, { "name": "size", "in": "query", "description": "Size of the page to retrieve" } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageControlPublicDtoV1" } } } } } } }, "/api/v1/public/evidences": { "get": { "tags": [ "Evidences" ], "summary": "Retrieve evidence for every control in an assessment", "operationId": "getAllEvidence", "parameters": [ { "name": "created.gte", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "updated.gte", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "description": "Zero based page to retrieve" }, { "name": "size", "in": "query", "description": "Size of the page to retrieve" }, { "name": "sort", "in": "query", "description": "Sort the results based one or more fields", "schema": { "type": "string", "enum": [ "createdAt,desc", "createdAt,asc", "createdAt", "lastUpdatedAt", "lastUpdatedAt,desc", "lastUpdatedAt,asc" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageEvidencePublicDtoV1" } } } } } } }, "/api/v1/public/controls/{controlId}": { "get": { "tags": [ "Controls" ], "summary": "Retrieve a control by its internal id", "operationId": "getControl", "parameters": [ { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "404": { "description": "Control not found", "content": { "application/json": { } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlPublicDtoV1" } } } } } } }, "/api/v1/public/control-scores/{controlScoreId}/actions": { "get": { "tags": [ "Assessment Control Scores" ], "summary": "A control score actions", "operationId": "findControlScoreActions", "parameters": [ { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreActionDtoV1" } } } } } } } }, "/api/v1/public/asset-groups": { "get": { "tags": [ "Asset-Groups" ], "summary": "Find all asset groups in customer environment", "operationId": "getAllAssetGroups", "parameters": [ { "name": "page", "in": "query", "description": "Zero based page to retrieve" }, { "name": "size", "in": "query", "description": "Size of the page to retrieve" }, { "name": "sort", "in": "query", "description": "Sort the results based one or more fields", "schema": { "type": "string", "enum": [ "name,desc", "name,asc" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAssetGroupResponseV1" } } } } } } }, "/api/v1/public/asset-groups/{assetGroupId}/risks": { "get": { "tags": [ "Asset-Groups" ], "summary": "Find all risks associated with the asset group", "operationId": "findAllRisks", "parameters": [ { "name": "assetGroupId", "in": "path", "description": "The id of the asset group", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "description": "Zero based page to retrieve" }, { "name": "size", "in": "query", "description": "Size of the page to retrieve" } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageRiskResponseV1" } } } } } } }, "/api/v1/public/asset-groups/{assetGroupId}/control-scores": { "get": { "tags": [ "Asset-Groups" ], "summary": "Find all control scores associated with the asset group", "operationId": "findAllControlScores", "parameters": [ { "name": "assetGroupId", "in": "path", "description": "The id of the asset group", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "description": "Zero based page to retrieve" }, { "name": "size", "in": "query", "description": "Size of the page to retrieve" } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageControlScorePublicDtoV1" } } } } } } }, "/api/v1/public/assessments": { "get": { "tags": [ "Assessments" ], "summary": "Retrieve an assessment", "operationId": "findAll_2", "parameters": [ { "name": "includeControls", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "page", "in": "query", "description": "Zero based page to retrieve" }, { "name": "size", "in": "query", "description": "Size of the page to retrieve. When the includeControls parameter is included and set to true, size will be restricted to a maximum value of 10 due to payload size considerations." }, { "name": "sort", "in": "query", "description": "Sort the results based one or more fields", "schema": { "type": "string", "enum": [ "createdAt,desc", "createdAt,asc", "createdAt", "lastUpdatedAt", "lastUpdatedAt,desc", "lastUpdatedAt,asc", "name", "name,desc", "name,asc", "percentComplete", "percentComplete,desc", "percentComplete,asc" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageAssessmentPublicDtoV1" } } } } } } }, "/api/v1/public/assessments/{id}": { "get": { "tags": [ "Assessments" ], "summary": "Retrieve an assessment by id", "operationId": "findById_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "includeControls", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentPublicDtoV1" } } } } } } }, "/api/v1/public/assessments/{id}/csf": { "get": { "tags": [ "Assessments" ], "summary": "Retrieve the NIST CSF Scores for an assessment", "operationId": "findCsfScores", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentCsfScoresResponseV1" } } } } } } }, "/api/v1/public/assessments/{assessmentId}/metadata": { "get": { "tags": [ "Assessments" ], "summary": "Retrieve all metadata fields that are associated with an assessment", "operationId": "getMetadata", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessmentMetadataFieldsResponseV1" } } } } } } }, "/api/v1/public/assessments/{assessmentId}/evidences": { "get": { "tags": [ "Assessments" ], "summary": "Retrieve evidence for every control in an assessment", "operationId": "getEvidence_1", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "created.gte", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "updated.gte", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "description": "Zero based page to retrieve" }, { "name": "size", "in": "query", "description": "Size of the page to retrieve" }, { "name": "sort", "in": "query", "description": "Sort the results based one or more fields", "schema": { "type": "string", "enum": [ "createdAt,desc", "createdAt,asc", "createdAt", "lastUpdatedAt", "lastUpdatedAt,desc", "lastUpdatedAt,asc" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageEvidencePublicDtoV1" } } } } } } }, "/api/v1/public/assessments/{assessmentId}/control-scores": { "get": { "tags": [ "Assessments" ], "summary": "Retrieve all the control scores associated with an assessment", "operationId": "findAllControlScores_1", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "description": "Zero based page to retrieve" }, { "name": "size", "in": "query", "description": "Size of the page to retrieve" } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageControlScorePublicDtoV1" } } } } } } }, "/api/admin/vulnerability-scan-templates/{templateId}/entries": { "get": { "tags": [ "vulnerability-scan-template-controller" ], "operationId": "getVulnerabilityScanTemplateEntrySummaries", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VulnerabilityScanTemplateEntrySummary" } } } } } } } }, "/api/admin/vulnerability-scan-template-summaries": { "get": { "tags": [ "vulnerability-scan-template-controller" ], "operationId": "getVulnerabilityScanTemplateSummaries", "parameters": [ { "name": "templateName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "frameworkName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PageVulnerabilityScanTemplate" } } } } } } }, "/api/admin/sp80053-controls": { "get": { "tags": [ "sp-80053-controls-controller" ], "operationId": "findAllSp80053Controls", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sp80053Control" } } } } } } } }, "/api/admin/score-model": { "get": { "tags": [ "score-model-admin-controller" ], "operationId": "getAdminScoreModels", "parameters": [ { "name": "searchText", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreModel" } } } } } } } }, "/api/admin/score-model/{scoreModelId}": { "get": { "tags": [ "score-model-admin-controller" ], "operationId": "getScoreModelById", "parameters": [ { "name": "scoreModelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ScoreModel" } } } } } } }, "/api/admin/score-model-value-set": { "get": { "tags": [ "score-model-admin-controller" ], "operationId": "getScoreModelValueSets", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreModelValueSetDto" } } } } } } } }, "/api/admin/score-guidance-sets": { "get": { "tags": [ "score-guidance-admin-controller" ], "operationId": "getAllScoreGuidanceSetDtos", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreGuidanceSetDto" } } } } } } } }, "/api/admin/score-guidance-sets/{scoreGuidanceSetId}": { "get": { "tags": [ "score-guidance-admin-controller" ], "operationId": "getScoreGuidanceSet", "parameters": [ { "name": "scoreGuidanceSetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ScoreGuidanceSet" } } } } } } }, "/api/admin/scheduled-jobs": { "get": { "tags": [ "scheduled-job-controller" ], "operationId": "getJobs", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledJobResponse" } } } } } } } }, "/api/admin/scheduled-jobs/{id}": { "get": { "tags": [ "scheduled-job-controller" ], "operationId": "getJob", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ScheduledJob" } } } } } } }, "/api/admin/scheduled-job/{id}/scheduled-job-histories": { "get": { "tags": [ "scheduled-job-controller" ], "operationId": "getScheduledJobHistories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledJobHistory" } } } } } } } }, "/api/admin/risk-remediation-projects/migrate-all-projects": { "get": { "tags": [ "admin-risk-remediation-project-controller" ], "operationId": "migrateAllExistingRemediationProjects", "responses": { "200": { "description": "OK" } } } }, "/api/admin/reports/customer-stats": { "get": { "tags": [ "admin-metrics-controller" ], "operationId": "generateCustomerStatsReport", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/admin/reports/customer-health": { "get": { "tags": [ "admin-metrics-controller" ], "operationId": "generateCustomerHealthReport", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/api/admin/report-types": { "get": { "tags": [ "admin-report-controller" ], "operationId": "getReportTypes", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportType" } } } } } } } }, "/api/admin/policy-templates/{policyTemplateId}/integration-mappings": { "get": { "tags": [ "integration-controller" ], "operationId": "getMappingsSummaryForPolicyTemplate", "parameters": [ { "name": "policyTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlToPoliciesSummary" } } } } } } } }, "/api/admin/module": { "get": { "tags": [ "module-controller" ], "operationId": "getModules", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentModule" } } } } } } } }, "/api/admin/level-models": { "get": { "tags": [ "level-model-module-admin-controller" ], "operationId": "getLevelModels", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LevelScoringModuleEntry" } } } } } } } }, "/api/admin/integration-sources": { "get": { "tags": [ "integration-controller" ], "operationId": "getIntegrationSources", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "enabledOnly", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationSource" } } } } } } } }, "/api/admin/integration-sources/{sourceId}": { "get": { "tags": [ "integration-controller" ], "operationId": "getIntegrationSource", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/IntegrationSource" } } } } } } }, "/api/admin/integration-sources/{sourceId}/policies": { "get": { "tags": [ "integration-controller" ], "operationId": "getIntegrationPoliciesForSource", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationPolicy" } } } } } } } }, "/api/admin/frameworks/{frameworkId}/metadata": { "get": { "tags": [ "framework-metadata-controller" ], "operationId": "findAllAsAdmin", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkMetadataField" } } } } } } } }, "/api/admin/frameworks/{frameworkId}/integration-control-entries/": { "get": { "tags": [ "integration-controller" ], "operationId": "getIntegrationControlEntries", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationControlEntry" } } } } } } } }, "/api/admin/framework/{frameworkId}/control/{controlId}/customer/{customerId}/score-guidance-summary": { "get": { "tags": [ "score-guidance-admin-controller" ], "operationId": "getScoreGuidanceSummaryForControl", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreGuidanceSummaryDto" } } } } } } } }, "/api/admin/framework/controlWorkflow/{customerId}": { "get": { "tags": [ "framework-admin-controller" ], "operationId": "getControlWorkflowOptionsForCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWorkflowGroupDefinitionWithOptions" } } } } } } } }, "/api/admin/framework/config": { "get": { "tags": [ "framework-admin-controller" ], "operationId": "frameworkConfig", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FrameworkAdminConfig" } } } } } } }, "/api/admin/data-lake-templates/{templateId}/entries": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getDataLakeTemplateEntries", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeEntriesDto" } } } } } } } }, "/api/admin/data-lake-templates/{templateId}/entries/templated": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getDataLakeTemplateEntriesTemplated", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeEntriesTemplatedDto" } } } } } } } }, "/api/admin/data-lake-templates/{templateId}/entries/ad-hoc": { "get": { "tags": [ "data-lake-template-controller" ], "operationId": "getDataLakeTemplateEntriesAdHoc", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeEntriesAdHocDto" } } } } } } } }, "/api/admin/customers/stats": { "get": { "tags": [ "customer-admin-controller" ], "operationId": "findStats", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CustomerOverallStats" } } } } } } }, "/api/admin/customers/search": { "get": { "tags": [ "customer-admin-controller" ], "operationId": "search", "parameters": [ { "name": "searchParams", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CustomerListQueryParams" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWithStats" } } } } } } } }, "/api/admin/customer/{customerId}/features": { "get": { "tags": [ "customer-admin-controller" ], "operationId": "getCustomerSelectedFeatures", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } } } }, "/api/admin/customer/feature-packages": { "get": { "tags": [ "customer-admin-controller" ], "operationId": "getFeaturePackages", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPackageDto" } } } } } } } }, "/api/admin/current-global-basic-user": { "get": { "tags": [ "current-user-controller" ], "operationId": "findCurrentGlobalAdminUser", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BasicUserDto" } } } } } } }, "/api/admin/csf-subcategories": { "get": { "tags": [ "csf-admin-controller" ], "operationId": "findAllSubcategories", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/api/admin/audit-logs": { "get": { "tags": [ "audit-log-admin-controller" ], "operationId": "getAdminAuditLogs_1_1", "parameters": [ { "name": "pageable", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Pageable" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PageAuditLogUserCount" }, { "$ref": "#/components/schemas/PageAuditLogDto" }, { "$ref": "#/components/schemas/PageAuditLogEventCount" } ] } } } } } } }, "/api/admin/assessment-workflows/customers/{customerId}": { "get": { "tags": [ "assessment-workflow-global-admin-controller" ], "operationId": "findAllForCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentWorkflowGroup" } } } } } } } }, "/api/{token}/assessments/report-templates/{reportId}": { "delete": { "tags": [ "assessment-report-template-controller" ], "operationId": "delete", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/tenable/authentications/{integrationAuthId}": { "delete": { "tags": [ "tenable-integration-controller" ], "operationId": "deleteIntegrationAuthentication", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "integrationAuthId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/supplemental-score-model/{supplementalScoreModelId}": { "delete": { "tags": [ "supplemental-score-model-controller" ], "operationId": "deleteModel", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "supplementalScoreModelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/snowflake/authentications/{integrationAuthId}": { "delete": { "tags": [ "snowflake-integration-controller" ], "operationId": "deleteIntegrationAuthentication_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "integrationAuthId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risks/{riskId}/solutions/{solutionId}": { "delete": { "tags": [ "risk-controller" ], "operationId": "removeSolutionFromRisk", "parameters": [ { "name": "riskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "solutionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/risk-nist-categories/{id}": { "delete": { "tags": [ "risk-nist-category-controller" ], "operationId": "deleteRiskNistTypeById_1", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/postgres/authentications/{integrationAuthId}": { "delete": { "tags": [ "postgres-integration-controller" ], "operationId": "deleteIntegrationAuthentication_3", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "integrationAuthId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/manage/user/{userId}/delete": { "delete": { "tags": [ "user-controller" ], "operationId": "deleteUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/manage/framework/{frameworkId}": { "delete": { "tags": [ "framework-management-controller" ], "operationId": "deleteFramework", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/ibm/authentications/{integrationAuthId}": { "delete": { "tags": [ "ibm-integration-controller" ], "operationId": "deleteIntegrationAuthentication_4", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "integrationAuthId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/governance-dashboard/{pageId}": { "delete": { "tags": [ "governance-dashboard-controller" ], "operationId": "deleteGovernanceDashboard", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/crosswalk-templates/{crosswalkTemplateId}/mappings/{mappingId}": { "delete": { "tags": [ "crosswalk-template-controller" ], "operationId": "deleteCrosswalkTemplateMapping", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "crosswalkTemplateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mappingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkTemplateMappingDetails" } } } } } } } }, "/api/{customerToken}/azure/authentications/{integrationAuthId}": { "delete": { "tags": [ "azure-integration-controller" ], "operationId": "deleteIntegrationAuthentication_5", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "integrationAuthId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/aws/authentications/{integrationAuthId}": { "delete": { "tags": [ "aws-integration-controller" ], "operationId": "deleteIntegrationAuthentication_6", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "integrationAuthId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/assessment/{assessmentId}/control-score/assessor/{controlScoreId}/reference/{docRefId}": { "delete": { "tags": [ "assessor-module-controller" ], "operationId": "deleteDocRef", "parameters": [ { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlScoreId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "docRefId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AssessorModuleEntry" } } } } } } }, "/api/{customerToken}/assessment-automations/{assessmentId}": { "delete": { "tags": [ "integration-controller" ], "operationId": "deleteAssessmentAutomation", "parameters": [ { "name": "customerToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assessmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/{customerToken}/api-keys/{apiKeyId}": { "delete": { "tags": [ "api-key-controller" ], "operationId": "deleteApiKey", "parameters": [ { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/admin/score-model/delete/{scoreModelId}": { "delete": { "tags": [ "score-model-admin-controller" ], "operationId": "deleteModel_1", "parameters": [ { "name": "scoreModelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/admin/customer/{customerId}/framework/{frameworkId}/control-action/{controlActionId}": { "delete": { "tags": [ "score-guidance-admin-controller" ], "operationId": "removeScoreGuidanceFromControlAction", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "controlActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/admin/crosswalk-mappings/{id}": { "delete": { "tags": [ "crosswalk-mapping-controller" ], "operationId": "deleteMapping", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/admin/api-keys/{apiKeyId}": { "delete": { "tags": [ "internal-api-key-controller" ], "operationId": "deleteApiKey_1", "parameters": [ { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/admin/framework/{frameworkId}/controls/download": { "get": { "tags": [ "framework-admin-controller" ], "operationId": "downloadControls", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } }, "put": { "tags": [ "framework-admin-controller" ], "operationId": "downloadControls_3", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } }, "post": { "tags": [ "framework-admin-controller" ], "operationId": "downloadControls_2", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } }, "delete": { "tags": [ "framework-admin-controller" ], "operationId": "downloadControls_5", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } }, "options": { "tags": [ "framework-admin-controller" ], "operationId": "downloadControls_6", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } }, "head": { "tags": [ "framework-admin-controller" ], "operationId": "downloadControls_1", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } }, "patch": { "tags": [ "framework-admin-controller" ], "operationId": "downloadControls_4", "parameters": [ { "name": "frameworkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } } } } } }, "components": { "schemas": { "UpdateSnowflakeIntegrationAuthenticationRequest": { "required": [ "account", "description", "id", "organizationalUnitId", "privateKey", "role", "user", "warehouse" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "account": { "maxLength": 255, "minLength": 0, "type": "string" }, "user": { "maxLength": 255, "minLength": 0, "type": "string" }, "privateKey": { "maxLength": 2048, "minLength": 0, "type": "string" }, "warehouse": { "maxLength": 255, "minLength": 0, "type": "string" }, "role": { "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "SnowflakeSourceAuthenticationDetailsSecure": { "required": [ "account", "role", "user", "warehouse" ], "type": "object", "properties": { "account": { "type": "string" }, "user": { "type": "string" }, "warehouse": { "type": "string" }, "role": { "type": "string" } } }, "SnowflakeSourceAuthenticationSecure": { "required": [ "authentication", "description", "id", "organizationalUnitId", "sourceId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "sourceId": { "type": "string", "format": "uuid" }, "authentication": { "$ref": "#/components/schemas/SnowflakeSourceAuthenticationDetailsSecure" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "UpdateUserSettingsRequest": { "required": [ "email", "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "maxLength": 255, "minLength": 0, "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "lastName": { "maxLength": 255, "minLength": 0, "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "email": { "maxLength": 255, "minLength": 0, "type": "string" } } }, "BasicUserDto": { "required": [ "displayName", "enabled", "firstName", "id", "isDeleted", "lastName" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "isDeleted": { "type": "boolean" }, "isVerified": { "type": "boolean" }, "enabled": { "type": "boolean" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "displayName": { "type": "string" } } }, "CreateOrUpdateRoleRequest": { "required": [ "name", "organizationalUnitId" ], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "description": { "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "Role": { "required": [ "id", "name", "organizationalUnitId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "lastUpdatedBy": { "type": "string", "format": "uuid" } } }, "BahOption": { "required": [ "id", "label", "title", "value" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "value": { "type": "number", "format": "double" }, "label": { "type": "string" } } }, "BahOptionSet": { "required": [ "id", "options", "question", "title" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "question": { "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/BahOption" } } } }, "BahRiskRequestScore": { "required": [ "option", "optionSet" ], "type": "object", "properties": { "optionSet": { "$ref": "#/components/schemas/BahOptionSet" }, "option": { "$ref": "#/components/schemas/BahOption" }, "note": { "type": "string" } } }, "MitreTactic": { "required": [ "attackSpecVersion", "createdAt", "description", "id", "modifiedAt", "name", "revoked" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "revoked": { "type": "boolean" }, "attackSpecVersion": { "type": "string" }, "tacticId": { "type": "string" }, "shortName": { "type": "string" }, "description": { "type": "string" }, "externalId": { "type": "string" } } }, "MitreTechniqueDto": { "required": [ "attackSpecVersion", "createdAt", "description", "id", "isSubTechnique", "modifiedAt", "name", "revoked", "tactic", "techniqueId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "revoked": { "type": "boolean" }, "attackSpecVersion": { "type": "string" }, "techniqueId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "isSubTechnique": { "type": "boolean" }, "parentTechniqueId": { "type": "string" }, "externalId": { "type": "string" }, "tactic": { "$ref": "#/components/schemas/MitreTactic" } } }, "SimpleRiskRequest": { "required": [ "name", "owners", "riskNistTypeId" ], "type": "object", "properties": { "name": { "type": "string" }, "riskNistCategoryId": { "type": "string", "format": "uuid" }, "riskNistTypeId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "owners": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "UpdateBahRiskRequest": { "required": [ "controlIds", "controlScoreIds", "mitreTechniqueDtos", "risk", "riskRegisterId", "scores" ], "type": "object", "properties": { "riskRegisterId": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" }, "risk": { "$ref": "#/components/schemas/SimpleRiskRequest" }, "scores": { "type": "array", "items": { "$ref": "#/components/schemas/BahRiskRequestScore" } }, "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlScoreIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "mitreTechniqueDtos": { "type": "array", "items": { "$ref": "#/components/schemas/MitreTechniqueDto" } }, "treatmentPlanSelectedOptionId": { "type": "string", "format": "uuid" }, "treatmentPlanDueDate": { "type": "string", "format": "date-time" }, "treatmentPlanNote": { "type": "string" } } }, "RemediationControlTarget": { "required": [ "controlScoreId" ], "type": "object", "properties": { "controlScoreId": { "type": "string", "format": "uuid" } } }, "RiskRemediationProjectRequest": { "required": [ "controlIds", "controlScoreActionTargetScores", "durationMonths", "durationYears", "laborCostMax", "laborCostMedian", "laborCostMin", "name", "oneTimeCostMax", "oneTimeCostMedian", "oneTimeCostMin", "ownerIds", "projectCost", "projectType", "recurringCostMax", "recurringCostMedian", "recurringCostMin", "riskRemediationDashboardId", "startDate" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "priority": { "type": "string", "format": "uuid" }, "status": { "type": "string", "format": "uuid" }, "durationYears": { "type": "integer", "format": "int32" }, "durationMonths": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "oneTimeCostMin": { "type": "number" }, "oneTimeCostMax": { "type": "number" }, "oneTimeCostMedian": { "type": "number" }, "oneTimeCostDescription": { "type": "string" }, "laborCostMin": { "type": "number" }, "laborCostMax": { "type": "number" }, "laborCostMedian": { "type": "number" }, "laborCostDescription": { "type": "string" }, "recurringCostMin": { "type": "number" }, "recurringCostMax": { "type": "number" }, "recurringCostMedian": { "type": "number" }, "recurringCostDescription": { "type": "string" }, "projectCost": { "type": "number" }, "projectType": { "type": "string", "enum": [ "RISKS", "CONTROLS" ] }, "ownerIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlScoreIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "selectedAssessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskRemediationDashboardId": { "type": "string", "format": "uuid" }, "controlScoreActionTargetScores": { "type": "array", "items": { "$ref": "#/components/schemas/RemediationControlTarget" } } } }, "RiskRemediationProject": { "required": [ "annualizedProjectCost", "createdAt", "createdBy", "customerId", "durationMonths", "durationYears", "id", "laborCostMax", "laborCostMedian", "laborCostMin", "lastUpdated", "lastUpdatedBy", "name", "oneTimeCostMax", "oneTimeCostMedian", "oneTimeCostMin", "overallInherentRisk", "overallResidualRisk", "projectCost", "recurringCostMax", "recurringCostMedian", "recurringCostMin", "riskRemediationDashboardId", "startDate" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "priority": { "type": "string", "format": "uuid" }, "status": { "type": "string", "format": "uuid" }, "durationYears": { "type": "integer", "format": "int32" }, "durationMonths": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "oneTimeCostMin": { "type": "number" }, "oneTimeCostMax": { "type": "number" }, "oneTimeCostMedian": { "type": "number" }, "oneTimeCostDescription": { "type": "string" }, "laborCostMin": { "type": "number" }, "laborCostMax": { "type": "number" }, "laborCostMedian": { "type": "number" }, "laborCostDescription": { "type": "string" }, "recurringCostMin": { "type": "number" }, "recurringCostMax": { "type": "number" }, "recurringCostMedian": { "type": "number" }, "recurringCostDescription": { "type": "string" }, "projectCost": { "type": "number" }, "annualizedProjectCost": { "type": "number", "format": "double" }, "projectType": { "type": "string", "enum": [ "RISKS", "CONTROLS" ] }, "customerId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "lastUpdated": { "type": "string", "format": "date-time" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" } }, "rosi": { "type": "integer", "format": "int32" }, "riskReduction": { "type": "number", "format": "double" }, "overallInherentRisk": { "type": "number", "format": "double" }, "overallResidualRisk": { "type": "number", "format": "double" }, "riskReductionPercentage": { "type": "number", "format": "double" }, "annualizedLossExpectancy": { "type": "number", "format": "double" }, "csfCategoryProgress": { "type": "number", "format": "double" }, "riskRemediationDashboardId": { "type": "string", "format": "uuid" } } }, "UserDto": { "required": [ "displayName", "email", "firstName", "id", "isDeleted", "lastName" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "isDeleted": { "type": "boolean" }, "email": { "type": "string" }, "displayName": { "type": "string" } } }, "RiskRegisterUpdateRequest": { "required": [ "name", "organizationalUnitId" ], "type": "object", "properties": { "name": { "type": "string" }, "assessmentId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "assetGroups": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "RiskRegisterDto": { "required": [ "customerId", "id", "name", "organizationalUnitId", "riskRegisterMethodId" ], "type": "object", "properties": { "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "id": { "type": "string", "format": "uuid" }, "riskRegisterMethodId": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" }, "riskModelId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "assetGroupIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "CreateRiskNistCategory": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "idx": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "riskNistTypeId": { "type": "string", "format": "uuid" } } }, "CreateRiskNistTypeRequest": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "riskCategories": { "type": "array", "items": { "$ref": "#/components/schemas/CreateRiskNistCategory" } } } }, "Risk": { "required": [ "canBeIndustryRiskSynced", "createdBy", "customerId", "id", "isIndustryRiskSynced", "lastUpdatedBy", "name", "revision", "riskMethod", "riskRegisterId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "lastUpdated": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "riskRegisterId": { "type": "string", "format": "uuid" }, "riskMethod": { "type": "string", "enum": [ "FAIR", "NIST", "BAH" ] }, "externalId": { "maxLength": 255, "minLength": 0, "type": "string" }, "templateId": { "type": "string", "format": "uuid" }, "isIndustryRiskSynced": { "type": "boolean" }, "canBeIndustryRiskSynced": { "type": "boolean" }, "categoryId": { "type": "string", "format": "uuid" }, "riskNistCategoryId": { "type": "string", "format": "uuid" }, "riskNistTypeId": { "type": "string", "format": "uuid" } } }, "RiskNistCategory": { "required": [ "createdAt", "customerId", "isReadOnly", "lastUpdated", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "idx": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "isReadOnly": { "type": "boolean" }, "riskNistTypeId": { "type": "string", "format": "uuid" }, "attackVectorId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "lastUpdated": { "type": "string", "format": "date-time" } } }, "RiskNistCategorySummary": { "required": [ "riskNistCategory" ], "type": "object", "properties": { "riskNistCategory": { "$ref": "#/components/schemas/RiskNistCategory" }, "risks": { "type": "array", "items": { "$ref": "#/components/schemas/Risk" } } } }, "RiskNistType": { "required": [ "createdAt", "customerId", "id", "isReadOnly", "lastUpdated", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "isReadOnly": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "lastUpdated": { "type": "string", "format": "date-time" } } }, "RiskNistTypeSummary": { "required": [ "riskNistType" ], "type": "object", "properties": { "riskNistType": { "$ref": "#/components/schemas/RiskNistType" }, "risks": { "type": "array", "items": { "$ref": "#/components/schemas/Risk" } }, "riskCategories": { "type": "array", "items": { "$ref": "#/components/schemas/RiskNistCategorySummary" } } } }, "LegendValueDto": { "required": [ "color", "id", "label", "seq" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "maxLength": 50, "minLength": 0, "type": "string" }, "color": { "type": "string" }, "seq": { "type": "integer", "format": "int32" } } }, "QualitativePresetDto": { "required": [ "id", "max", "min", "mostLikely", "optionType", "order", "presetType", "subtitle", "title" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "riskModelId": { "type": "string", "format": "uuid" }, "presetType": { "type": "string", "enum": [ "IMPACT", "LIKELIHOOD" ] }, "optionType": { "type": "string", "enum": [ "VERY_LOW", "LOW", "LOW_AS_FIRST", "LOW_AS_NEXT", "MODERATE", "HIGH", "HIGH_AS_NEXT", "HIGH_AS_LAST", "VERY_HIGH_AS_NEXT", "VERY_HIGH_AS_LAST", "SEVERE", "CERTAIN" ] }, "order": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "min": { "type": "number" }, "max": { "type": "number" }, "mostLikely": { "type": "number" } } }, "RiskModelConfigRequest": { "required": [ "enabled", "heatMapValues", "impactPresets", "impacts", "legendValues", "likelihoodPresets", "likelihoods", "name" ], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string" }, "enabled": { "type": "boolean" }, "impacts": { "type": "array", "items": { "$ref": "#/components/schemas/RiskModelValueDto" } }, "likelihoods": { "type": "array", "items": { "$ref": "#/components/schemas/RiskModelValueDto" } }, "legendValues": { "type": "array", "items": { "$ref": "#/components/schemas/LegendValueDto" } }, "heatMapValues": { "type": "array", "items": { "$ref": "#/components/schemas/RiskModelHeatMapEntryDto" } }, "impactPresets": { "type": "array", "items": { "$ref": "#/components/schemas/QualitativePresetDto" } }, "likelihoodPresets": { "type": "array", "items": { "$ref": "#/components/schemas/QualitativePresetDto" } } } }, "RiskModelHeatMapEntryDto": { "required": [ "impactIndex", "legendValueId", "likelihoodIndex", "value" ], "type": "object", "properties": { "impactIndex": { "type": "integer", "format": "int32" }, "likelihoodIndex": { "type": "integer", "format": "int32" }, "legendValueId": { "type": "string", "format": "uuid" }, "value": { "type": "number" } } }, "RiskModelValueDto": { "required": [ "id", "label", "seq", "value" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "maxLength": 50, "minLength": 0, "type": "string" }, "value": { "maximum": 10, "minimum": 1, "type": "number" }, "seq": { "type": "integer", "format": "int32" } } }, "QualitativePreset": { "required": [ "id", "max", "min", "mostLikely", "optionType", "order", "presetType", "riskModelId", "subtitle", "title" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "riskModelId": { "type": "string", "format": "uuid" }, "presetType": { "type": "string", "enum": [ "IMPACT", "LIKELIHOOD" ] }, "optionType": { "type": "string", "enum": [ "VERY_LOW", "LOW", "LOW_AS_FIRST", "LOW_AS_NEXT", "MODERATE", "HIGH", "HIGH_AS_NEXT", "HIGH_AS_LAST", "VERY_HIGH_AS_NEXT", "VERY_HIGH_AS_LAST", "SEVERE", "CERTAIN" ] }, "order": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "min": { "type": "number" }, "max": { "type": "number" }, "mostLikely": { "type": "number" } } }, "RiskModelConfig": { "required": [ "heatMap", "presets", "riskModel", "riskUsageCount" ], "type": "object", "properties": { "riskModel": { "$ref": "#/components/schemas/RiskModelDto" }, "heatMap": { "$ref": "#/components/schemas/RiskModelHeatMapDto" }, "presets": { "$ref": "#/components/schemas/RiskModelPresetsDto" }, "riskUsageCount": { "type": "integer", "format": "int32" } } }, "RiskModelDto": { "required": [ "customerId", "enabled", "id", "impactCount", "impacts", "legendValues", "likelihoodCount", "likelihoods", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "impactCount": { "type": "integer", "format": "int32" }, "likelihoodCount": { "type": "integer", "format": "int32" }, "customerId": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" }, "impacts": { "type": "array", "items": { "$ref": "#/components/schemas/RiskModelValueDto" } }, "likelihoods": { "type": "array", "items": { "$ref": "#/components/schemas/RiskModelValueDto" } }, "legendValues": { "type": "array", "items": { "$ref": "#/components/schemas/LegendValueDto" } } } }, "RiskModelHeatMapDto": { "required": [ "entries", "riskModelId" ], "type": "object", "properties": { "riskModelId": { "type": "string", "format": "uuid" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/RiskModelHeatMapEntryDto" } } } }, "RiskModelPresetsDto": { "required": [ "impactPresets", "likelihoodPresets", "riskModelId" ], "type": "object", "properties": { "riskModelId": { "type": "string", "format": "uuid" }, "impactPresets": { "type": "array", "items": { "$ref": "#/components/schemas/QualitativePreset" } }, "likelihoodPresets": { "type": "array", "items": { "$ref": "#/components/schemas/QualitativePreset" } } } }, "ControlToPolicyMapping": { "required": [ "controlId", "policyId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "controlId": { "type": "string", "format": "uuid" }, "controlActionId": { "type": "string", "format": "uuid" }, "policyId": { "type": "string", "format": "uuid" } } }, "CreateOrUpdatePolicyTemplateRequest": { "required": [ "controlToIntegrationPolicyMappings", "frameworkId", "name", "sourceId" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string" }, "frameworkId": { "type": "string", "format": "uuid" }, "sourceId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "controlToIntegrationPolicyMappings": { "type": "array", "items": { "$ref": "#/components/schemas/ControlToPolicyMapping" } } } }, "CreateOrUpdateOrganizationalUnitRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "description": { "type": "string" }, "parentId": { "type": "string", "format": "uuid" } } }, "OrganizationalUnit": { "required": [ "customerId", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "parentId": { "type": "string", "format": "uuid" }, "lastUpdatedBy": { "type": "string", "format": "uuid" } } }, "AssessmentNotifications": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" }, "assessmentIdentifier": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "assessmentName": { "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "notifications": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "CONTROL_SCORE_CHANGED", "CONTROL_ASSIGNED", "NOTE_ADDED", "EVIDENCE_ADDED", "WORKFLOW_CHANGED" ] } }, "empty": { "type": "boolean" } } }, "UpdateNotificationRequest": { "required": [ "notifications" ], "type": "object", "properties": { "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentNotifications" } } } }, "UpdateDefaultNotificationsRequest": { "required": [ "defaultNotifications" ], "type": "object", "properties": { "defaultNotifications": { "type": "array", "items": { "type": "string", "enum": [ "CONTROL_SCORE_CHANGED", "CONTROL_ASSIGNED", "NOTE_ADDED", "EVIDENCE_ADDED", "WORKFLOW_CHANGED" ] } } } }, "ControlWeights": { "required": [ "controlId", "detectionWeight", "preventionWeight", "responseWeight" ], "type": "object", "properties": { "controlId": { "type": "string", "format": "uuid" }, "controlScoreId": { "type": "string", "format": "uuid" }, "detectionWeight": { "maximum": 99, "exclusiveMaximum": false, "minimum": 0, "exclusiveMinimum": false, "type": "number", "format": "double" }, "preventionWeight": { "maximum": 99, "exclusiveMaximum": false, "minimum": 0, "exclusiveMinimum": false, "type": "number", "format": "double" }, "responseWeight": { "maximum": 99, "exclusiveMaximum": false, "minimum": 0, "exclusiveMinimum": false, "type": "number", "format": "double" } } }, "CreateNist80030RiskRequest": { "required": [ "associatedControlIds", "associatedControlScoreIds", "controlWeights", "impact", "likelihood", "method", "name", "owners", "riskRegisterId", "singleLossExpectancyMax", "singleLossExpectancyMin", "singleLossExpectancyMostLikely", "threatEventFrequencyMaxEvents", "threatEventFrequencyMaxYears", "threatEventFrequencyMinEvents", "threatEventFrequencyMinYears", "threatEventFrequencyMostLikelyEvents", "threatEventFrequencyMostLikelyYears" ], "type": "object", "properties": { "name": { "type": "string" }, "categoryId": { "type": "string", "format": "uuid" }, "riskNistCategoryId": { "type": "string", "format": "uuid" }, "riskNistTypeId": { "type": "string", "format": "uuid" }, "description": { "maxLength": 30000, "minLength": 0, "type": "string" }, "owners": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "externalId": { "type": "string" }, "likelihood": { "type": "string", "format": "uuid" }, "likelihoodDetails": { "maxLength": 2500, "minLength": 0, "type": "string" }, "impact": { "type": "string", "format": "uuid" }, "impactDetails": { "maxLength": 2500, "minLength": 0, "type": "string" }, "trend": { "type": "string", "enum": [ "UP", "NO_CHANGE", "DOWN" ] }, "associatedControlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "associatedControlScoreIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlWeights": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWeights" } }, "singleLossExpectancyMin": { "maximum": 999999999999999, "minimum": 0, "type": "integer", "format": "int64" }, "singleLossExpectancyMax": { "maximum": 999999999999999, "minimum": 0, "type": "integer", "format": "int64" }, "singleLossExpectancyMostLikely": { "maximum": 999999999999999, "minimum": 0, "type": "integer", "format": "int64" }, "target": { "$ref": "#/components/schemas/Nist80030RiskTargetRequest" }, "riskRegisterId": { "type": "string", "format": "uuid" }, "method": { "type": "string", "enum": [ "FAIR", "NIST", "BAH" ] }, "riskTreatmentPlanId": { "type": "string", "format": "uuid" }, "riskTreatmentPlanDueDate": { "type": "string", "format": "date-time" }, "riskTreatmentPlanNote": { "type": "string" }, "threatEventFrequencyMinEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatEventFrequencyMinYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatEventFrequencyMaxEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatEventFrequencyMaxYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatEventFrequencyMostLikelyEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatEventFrequencyMostLikelyYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" } } }, "Nist80030RiskTargetRequest": { "required": [ "likelihood", "singleLossExpectancyEnabled", "threatEventFrequencyMaxEvents", "threatEventFrequencyMaxYears", "threatEventFrequencyMinEvents", "threatEventFrequencyMinYears", "threatEventFrequencyMostLikelyEvents", "threatEventFrequencyMostLikelyYears" ], "type": "object", "properties": { "singleLossExpectancyEnabled": { "type": "boolean" }, "likelihood": { "type": "string", "format": "uuid" }, "singleLossExpectancyMostLikely": { "maximum": 999999999999999, "minimum": 0, "type": "integer", "format": "int64" }, "singleLossExpectancyMin": { "maximum": 999999999999999, "minimum": 0, "type": "integer", "format": "int64" }, "singleLossExpectancyMax": { "maximum": 999999999999999, "minimum": 0, "type": "integer", "format": "int64" }, "targetDate": { "type": "string", "format": "date-time" }, "threatEventFrequencyMinEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number" }, "threatEventFrequencyMinYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number" }, "threatEventFrequencyMaxEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number" }, "threatEventFrequencyMaxYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number" }, "threatEventFrequencyMostLikelyEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number" }, "threatEventFrequencyMostLikelyYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number" } } }, "Nist80030RiskEntity": { "required": [ "annualizedLossExpectancy", "id", "impactId", "likelihoodId", "singleLossExpectancyMax", "singleLossExpectancyMaxFormatted", "singleLossExpectancyMin", "singleLossExpectancyMinFormatted", "singleLossExpectancyMostLikely", "singleLossExpectancyMostLikelyFormatted", "threatEventFrequencyMaxEvents", "threatEventFrequencyMaxYears", "threatEventFrequencyMinEvents", "threatEventFrequencyMinYears", "threatEventFrequencyMostLikelyEvents", "threatEventFrequencyMostLikelyYears" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "likelihoodId": { "type": "string", "format": "uuid" }, "likelihoodDetails": { "type": "string" }, "impactId": { "type": "string", "format": "uuid" }, "impactDetails": { "type": "string" }, "singleLossExpectancyMin": { "type": "integer", "format": "int64" }, "singleLossExpectancyMax": { "type": "integer", "format": "int64" }, "singleLossExpectancyMostLikely": { "type": "integer", "format": "int64" }, "trend": { "type": "string", "enum": [ "UP", "NO_CHANGE", "DOWN" ] }, "threatEventFrequencyMinEvents": { "type": "number", "format": "double" }, "threatEventFrequencyMinYears": { "type": "number", "format": "double" }, "threatEventFrequencyMaxEvents": { "type": "number", "format": "double" }, "threatEventFrequencyMaxYears": { "type": "number", "format": "double" }, "threatEventFrequencyMostLikelyEvents": { "type": "number", "format": "double" }, "threatEventFrequencyMostLikelyYears": { "type": "number", "format": "double" }, "singleLossExpectancyMinFormatted": { "type": "string" }, "singleLossExpectancyMaxFormatted": { "type": "string" }, "singleLossExpectancyMostLikelyFormatted": { "type": "string" }, "annualizedLossExpectancy": { "type": "integer", "format": "int64" } } }, "RiskAndNist80030Risk": { "required": [ "nist80030Risk", "risk" ], "type": "object", "properties": { "risk": { "$ref": "#/components/schemas/Risk" }, "nist80030Risk": { "$ref": "#/components/schemas/Nist80030RiskEntity" } } }, "Nist80030RiskTemplateXControl": { "required": [ "controlId", "createdAt", "createdBy", "detectionWeight", "id", "nist80030RiskTemplateId", "preventionWeight", "responseWeight" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "nist80030RiskTemplateId": { "type": "string", "format": "uuid" }, "controlId": { "type": "string", "format": "uuid" }, "detectionWeight": { "type": "number", "format": "double" }, "preventionWeight": { "type": "number", "format": "double" }, "responseWeight": { "type": "number", "format": "double" } } }, "UpdateUserRequest": { "required": [ "authenticationMethodId", "email", "firstName", "id", "isGlobalAdmin", "lastName", "organizationalUnitId" ], "type": "object", "properties": { "firstName": { "maxLength": 255, "minLength": 0, "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "lastName": { "maxLength": 255, "minLength": 0, "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "email": { "maxLength": 255, "minLength": 0, "type": "string" }, "id": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "authenticationMethodId": { "type": "string", "format": "uuid" }, "isGlobalAdmin": { "type": "boolean" } } }, "UpdateTagGroupWithTagRequest": { "required": [ "id", "name", "required" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "required": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateTagIdRequest" } } } }, "UpdateTagIdRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "id": { "type": "string", "format": "uuid" } } }, "AssessmentTagDto": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "assessments": { "type": "integer", "format": "int32" }, "totalAssessments": { "type": "integer", "format": "int32" }, "widgetCount": { "type": "integer", "format": "int32" }, "totalWidgetCount": { "type": "integer", "format": "int32" }, "assessmentNames": { "type": "array", "items": { "type": "string" } } } }, "AssessmentTagGroupAndTagsDto": { "required": [ "id", "name", "required", "tags" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "required": { "type": "boolean" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentTagDto" } } } }, "CreateTagRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" } } }, "UpdateFrameworkRequest": { "required": [ "name", "sspEnabled", "version" ], "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "parentId": { "type": "string", "format": "uuid" }, "sspEnabled": { "type": "boolean" } } }, "AssessmentChart": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "Control": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "controlFamily": { "type": "string" }, "controlLabel": { "type": "string" }, "parentControlLabel": { "type": "string" }, "auxiliaryControlLabel": { "type": "string" }, "description": { "type": "string" }, "supplementalGuidance": { "type": "string" }, "evidenceRequired": { "type": "string" }, "remediationSteps": { "type": "string" }, "remediationCost": { "type": "integer", "format": "int32" }, "remediationImpact": { "type": "integer", "format": "int32" }, "complianceDescription": { "type": "string" }, "scoreModelValueSetId": { "type": "string", "format": "uuid" }, "frameworkId": { "type": "string", "format": "uuid" }, "controlActions": { "type": "array", "items": { "$ref": "#/components/schemas/ControlActionDto" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/ControlTag" } }, "subcategories": { "type": "array", "items": { "$ref": "#/components/schemas/ControlSubcategory" } }, "params": { "$ref": "#/components/schemas/ControlParameters" } } }, "ControlActionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "content": { "type": "string" }, "idx": { "type": "integer", "format": "int32" }, "level": { "type": "integer", "format": "int32" }, "scoreModelValueSetId": { "type": "string", "format": "uuid" } } }, "ControlParameter": { "required": [ "choice", "howMany", "token" ], "type": "object", "properties": { "token": { "type": "string" }, "choice": { "type": "array", "items": { "type": "string" } }, "howMany": { "type": "string", "enum": [ "ONE_OR_MORE", "ONE" ] } } }, "ControlParameters": { "type": "object", "properties": { "params": { "type": "array", "items": { "$ref": "#/components/schemas/ControlParameter" } } } }, "ControlSubcategory": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "categoryId": { "type": "string" }, "categoryName": { "type": "string" }, "categoryDescription": { "type": "string" }, "functionId": { "type": "string", "format": "uuid" }, "functionName": { "type": "string" }, "functionUniqueIdentifier": { "type": "string" }, "csfFrameworkId": { "type": "string", "format": "uuid" } } }, "ControlTag": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "FrameworkAndControlsDto": { "required": [ "id", "name", "sspEnabled", "status" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "version": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "Regulatory", "Binary" ] }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "Draft", "Published", "Disabled" ] }, "parentId": { "type": "string", "format": "uuid" }, "customScoreModelId": { "type": "string", "format": "uuid" }, "customScoringModel": { "$ref": "#/components/schemas/ScoreModel" }, "controlScoreMethod": { "type": "string", "enum": [ "BINARY", "LEVEL", "REGULATORY", "CMMC_2" ] }, "assessmentScoreMethod": { "type": "string", "enum": [ "DFARS_171A", "RAW_CONTROL_FAMILY", "RAW_LEVELED_CONTROL_FAMILY", "RAW_PARENT_CONTROL_LABEL", "RAW", "CONTROL_FAMILY", "PARENT_CONTROL_LABEL", "CYBERSTRONG", "CMMC_2" ] }, "csfWeighted": { "type": "boolean" }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkModule" } }, "cybersecurityFrameworkId": { "type": "string", "format": "uuid" }, "supplementalScoreModelId": { "type": "string", "format": "uuid" }, "supplementalScoringModel": { "$ref": "#/components/schemas/SupplementalScoreModel" }, "controlWorkflowGroupDefinitionId": { "type": "string", "format": "uuid" }, "sspEnabled": { "type": "boolean" }, "controls": { "type": "array", "items": { "$ref": "#/components/schemas/Control" } }, "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assessmentCharts": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentChart" } }, "assessmentWorkflowGroupId": { "type": "string", "format": "uuid" } } }, "FrameworkModule": { "required": [ "frameworkId", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "frameworkId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "ScoreModel": { "required": [ "id", "name", "values" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreModelValue" } } } }, "ScoreModelValue": { "required": [ "id", "label", "order", "value" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "value": { "type": "number", "format": "double" }, "order": { "type": "integer", "format": "int32" }, "description": { "type": "string" } } }, "SupplementalScoreModel": { "required": [ "customerId", "id", "name", "values" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/SupplementalScoreModelValue" } } } }, "SupplementalScoreModelValue": { "required": [ "id", "name", "ordinal", "score", "supplementalScoreModelId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "supplementalScoreModelId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "score": { "type": "number", "format": "double" }, "ordinal": { "type": "integer", "format": "int32" } } }, "UpdateAssessmentRequest": { "required": [ "name", "organizationalUnitId" ], "type": "object", "properties": { "name": { "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "ownerId": { "type": "string", "format": "uuid" }, "tags": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "level": { "type": "integer", "format": "int32" }, "documentStorageLocation": { "type": "string" }, "metadataFields": { "type": "object", "additionalProperties": { "type": "string" } }, "assetGroupIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "AssessmentDto": { "required": [ "assessmentWorkflowOptionId", "assignableUsers", "availableUsers", "controlScores", "cyberstrongScore", "name", "tags" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "identifier": { "type": "string" }, "active": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "revision": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "frameworkId": { "type": "string", "format": "uuid" }, "owner": { "$ref": "#/components/schemas/AssessmentUserDto" }, "currentScore": { "type": "number" }, "targetScore": { "type": "number" }, "percentComplete": { "type": "integer", "format": "int32" }, "maturityModel": { "type": "string" }, "controlScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreDto" } }, "assignableUsers": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentUserDto" } }, "availableUsers": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentUserDto" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentTag" } }, "cyberstrongScore": { "type": "integer", "format": "int32" }, "maturityScore": { "type": "number" }, "normalizedMaturityScore": { "type": "number" }, "level": { "type": "integer", "format": "int32" }, "documentStorageLocation": { "type": "string" }, "assessmentWorkflowOptionId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "AssessmentModuleEntry": { "type": "object" }, "AssessmentTag": { "required": [ "assessmentTagGroupId", "customerId", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "assessmentTagGroupId": { "type": "string", "format": "uuid" } } }, "AssessmentUserDto": { "required": [ "displayName", "email", "enabled", "firstName", "id", "isDeleted", "isVerified", "lastName" ], "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" }, "isVerified": { "type": "boolean" }, "enabled": { "type": "boolean" }, "email": { "type": "string" }, "displayName": { "type": "string" } } }, "AssessorModuleEntry": { "required": [ "documentReferences", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" }, "controlScoreId": { "type": "string", "format": "uuid" }, "lastUpdatedNotes": { "type": "string", "format": "date-time" }, "lastUpdatedObservations": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "observations": { "type": "string" }, "respondentId": { "type": "string", "format": "uuid" }, "updatedById": { "type": "string", "format": "uuid" }, "documentReferences": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentReference" } } } }, "ControlActionScoreDto": { "required": [ "frameworkId", "isAutomated" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "frameworkId": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "updatedById": { "type": "string", "format": "uuid" }, "controlActionId": { "type": "string", "format": "uuid" }, "currentScoreModelValueId": { "type": "string", "format": "uuid" }, "targetScoreModelValueId": { "type": "string", "format": "uuid" }, "userResponsibilityScoreModelValueId": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "idx": { "type": "integer", "format": "int32" }, "controlScoreActionAnnotation": { "$ref": "#/components/schemas/ControlScoreActionAnnotationDto" }, "excludeFromScore": { "type": "boolean" }, "isAutomated": { "type": "boolean" }, "automationSourceIdList": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "implementationDetails": { "type": "string" }, "implementationStatus": { "type": "string" }, "implementationStatusRemarks": { "type": "string" } } }, "ControlActionSupplementalScore": { "required": [ "controlActionId", "controlScoreId", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "controlActionId": { "type": "string", "format": "uuid" }, "controlScoreId": { "type": "string", "format": "uuid" }, "supplementalScoreModelValueId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "updatedById": { "type": "string", "format": "uuid" } } }, "ControlScoreActionAnnotationDto": { "required": [ "annotation", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "annotation": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "updatedBy": { "$ref": "#/components/schemas/AssessmentUserDto" } } }, "ControlScoreDto": { "required": [ "controlActionScores", "controlActionSupplementalScores", "excludeFromScore", "inherentRisk", "modules", "residualRisk" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "updatedBy": { "$ref": "#/components/schemas/PrincipalDto" }, "assessmentId": { "type": "string", "format": "uuid" }, "controlId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "isFlagged": { "type": "boolean" }, "currentCompliance": { "type": "number", "format": "float" }, "assignedTo": { "$ref": "#/components/schemas/AssessmentUserDto" }, "riskImpact": { "type": "integer", "format": "int32" }, "riskLikelihood": { "type": "integer", "format": "int32" }, "targetScore": { "type": "number", "format": "float" }, "maturityScore": { "type": "number", "format": "double" }, "dataProtection": { "type": "string", "enum": [ "Confidentiality", "Integrity", "Availability" ] }, "threatType": { "type": "array", "items": { "type": "string", "enum": [ "Adversarial", "Accidental", "Environmental", "Structural" ] } }, "businessImpact": { "type": "array", "items": { "type": "string", "enum": [ "Financial", "Operational", "Reputational", "Regulatory and Legal" ] } }, "financialImpactMostLikely": { "type": "integer", "format": "int32" }, "financialImpactMin": { "type": "integer", "format": "int32" }, "financialImpactMax": { "type": "integer", "format": "int32" }, "completionCostValue": { "type": "integer", "format": "int32" }, "dueDate": { "type": "string", "format": "date-time" }, "dueDateRecurrence": { "type": "string", "enum": [ "MONTHLY", "QUARTERLY", "YEARLY" ] }, "controlWorkflowOptionId": { "type": "string", "format": "uuid" }, "excludeFromScore": { "type": "boolean" }, "responsibleRoles": { "type": "array", "items": { "type": "string" } }, "controlOrigination": { "type": "string" }, "collaboratorIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "collaborators": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentUserDto" } }, "controlActionScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlActionScoreDto" } }, "controlActionSupplementalScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlActionSupplementalScore" } }, "evidences": { "type": "array", "items": { "$ref": "#/components/schemas/EvidenceDto" } }, "normalizedCurrentCompliance": { "type": "number" }, "modules": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AssessmentModuleEntry" } }, "jiraUrl": { "type": "string" }, "normalizedTargetScore": { "type": "number", "format": "double" }, "paramValues": { "type": "object", "additionalProperties": { "type": "string" } }, "note": { "$ref": "#/components/schemas/NotesModuleEntry" }, "assessor": { "$ref": "#/components/schemas/AssessorModuleEntry" }, "inherentRisk": { "type": "number" }, "residualRisk": { "type": "number" } } }, "DocumentReference": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "assessorModuleControlEntryId": { "type": "string", "format": "uuid" }, "document": { "type": "integer", "format": "int32" }, "chapter": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "updatedById": { "type": "string", "format": "uuid" } } }, "EvidenceDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "location": { "type": "string" }, "createdById": { "type": "string", "format": "uuid" }, "createdByUser": { "$ref": "#/components/schemas/AssessmentUserDto" }, "createdAt": { "type": "string", "format": "date-time" } } }, "NotesModuleEntry": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "notes": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" } } }, "PrincipalDto": { "required": [ "displayName", "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "displayName": { "type": "string" }, "type": { "type": "string", "enum": [ "USER", "API", "SYSTEM" ] }, "email": { "type": "string" } } }, "CloneAssessmentRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" } } }, "CreateOrUpdateJiraConfigRequest": { "required": [ "baseUrl", "dueDateEnabled", "issueType", "projectId", "setToken", "username" ], "type": "object", "properties": { "projectId": { "type": "string" }, "issueType": { "type": "string" }, "baseUrl": { "type": "string" }, "username": { "type": "string" }, "token": { "type": "string" }, "dueDateEnabled": { "type": "boolean" }, "setToken": { "type": "boolean" } } }, "JiraConfig": { "required": [ "baseUrl", "customerId", "dueDateEnabled", "issueType", "username" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string" }, "issueType": { "type": "string" }, "baseUrl": { "type": "string" }, "username": { "type": "string" }, "dueDateEnabled": { "type": "boolean" } } }, "UpdateIbmIntegrationAuthenticationRequest": { "required": [ "accountId", "apiKey", "description", "id", "location", "organizationalUnitId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "accountId": { "pattern": "[a-f0-9]{32}", "type": "string" }, "location": { "type": "string" }, "apiKey": { "maxLength": 255, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "IbmSourceAuthenticationDetailsSecure": { "required": [ "accountId", "location" ], "type": "object", "properties": { "accountId": { "type": "string" }, "location": { "type": "string" } } }, "IbmSourceAuthenticationSecure": { "required": [ "authentication", "description", "id", "organizationalUnitId", "sourceId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "sourceId": { "type": "string", "format": "uuid" }, "authentication": { "$ref": "#/components/schemas/IbmSourceAuthenticationDetailsSecure" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "UpdateGroupRequest": { "required": [ "name", "organizationalUnitId", "roleId" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "roleId": { "type": "string", "format": "uuid" } } }, "Group": { "required": [ "customerId", "id", "name", "organizationalUnitId", "roleId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "roleId": { "type": "string", "format": "uuid" } } }, "CreateGovernanceDashboardWidgetRequest": { "required": [ "controlFamily", "controlFamilyCompare", "csfCategory", "csfCategoryCompare", "csfFunction", "csfFunctionCompare", "cybersecurityFrameworkId", "frameworkIds", "name", "tags" ], "type": "object", "properties": { "name": { "maxLength": 65, "minLength": 0, "type": "string" }, "controlFamily": { "type": "boolean" }, "csfFunction": { "type": "boolean" }, "csfCategory": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "frameworkIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "cybersecurityFrameworkId": { "type": "string", "format": "uuid" }, "controlFamilyCompare": { "type": "boolean" }, "csfFunctionCompare": { "type": "boolean" }, "csfCategoryCompare": { "type": "boolean" }, "compareDateOne": { "type": "string", "format": "date-time" }, "compareDateTwo": { "type": "string", "format": "date-time" } } }, "ModifyGovernanceDashboardRequest": { "required": [ "name", "organizationalUnitId" ], "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "widgetOrderDto": { "type": "array", "items": { "$ref": "#/components/schemas/WidgetOrderDto" } } } }, "WidgetOrderDto": { "required": [ "order", "widgetId" ], "type": "object", "properties": { "widgetId": { "type": "string", "format": "uuid" }, "order": { "type": "integer", "format": "int32" } } }, "GovernanceDashboardPage": { "required": [ "customerId", "id", "name", "organizationalUnitId", "widgetIds" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "widgetIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "FeatureFlagUpdateRequest": { "required": [ "isEnabled" ], "type": "object", "properties": { "isEnabled": { "type": "boolean" } } }, "FeatureFlag": { "required": [ "id", "isComplete", "isEnabled", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "enum": [ "CCA_RESULTS_IMPORT", "KNIGHT_VISION_REPORT", "AUTOMATION_SUMMARY", "AUTOMATION_IMPROVEMENTS", "INTEGRATION_POSTGRES", "FINDINGS" ] }, "isEnabled": { "type": "boolean" }, "isComplete": { "type": "boolean" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "lastUpdatedAt": { "type": "string", "format": "date-time" } } }, "CategoryLoss": { "required": [ "category", "id", "lossMax", "lossMin", "lossMostLikely" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "category": { "type": "string", "enum": [ "PRODUCTIVITY", "RESPONSE", "REPLACEMENT", "COMPETITIVE_ADVANTAGE", "FINES_AND_JUDGEMENTS", "REPUTATION" ] }, "lossMin": { "type": "integer", "format": "int64" }, "lossMax": { "type": "integer", "format": "int64" }, "lossMostLikely": { "type": "integer", "format": "int64" } } }, "CreateFairRiskRequest": { "required": [ "associatedControlIds", "associatedControlScoreIds", "name", "owners", "riskRegisterId" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "categoryId": { "type": "string", "format": "uuid" }, "description": { "maxLength": 30000, "minLength": 0, "type": "string" }, "owners": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "externalId": { "type": "string" }, "lossFrequencyMinEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "lossFrequencyMinYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "lossFrequencyMaxEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "lossFrequencyMaxYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "lossFrequencyMostLikelyEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "lossFrequencyMostLikelyYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "lossFrequencyDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "lossMagnitudeMin": { "type": "integer", "format": "int64" }, "lossMagnitudeMax": { "type": "integer", "format": "int64" }, "lossMagnitudeMostLikely": { "type": "integer", "format": "int64" }, "lossMagnitudeDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "threatFrequencyMinEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatFrequencyMinYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatFrequencyMaxEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatFrequencyMaxYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatFrequencyMostLikelyEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatFrequencyMostLikelyYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatFrequencyDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "vulnerabilityMin": { "type": "number" }, "vulnerabilityMax": { "type": "number" }, "vulnerabilityMostLikely": { "type": "number" }, "vulnerabilityDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "contactFrequencyMinEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "contactFrequencyMinYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "contactFrequencyMaxEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "contactFrequencyMaxYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "contactFrequencyMostLikelyEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "contactFrequencyMostLikelyYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "contactFrequencyDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "probabilityOfActionMin": { "type": "number" }, "probabilityOfActionMax": { "type": "number" }, "probabilityOfActionMostLikely": { "type": "number" }, "probabilityOfActionDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "threatCapabilityMin": { "type": "number" }, "threatCapabilityMax": { "type": "number" }, "threatCapabilityMostLikely": { "type": "number" }, "threatCapabilityDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "resistanceStrengthMin": { "type": "number" }, "resistanceStrengthMax": { "type": "number" }, "resistanceStrengthMostLikely": { "type": "number" }, "resistanceStrengthDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "primaryLoss": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryLoss" } }, "primaryLossDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "secondaryLefMin": { "type": "number" }, "secondaryLefMax": { "type": "number" }, "secondaryLefMostLikely": { "type": "number" }, "secondaryLefDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "secondaryLm": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryLoss" } }, "secondaryLmDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "associatedControlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "associatedControlScoreIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskRegisterId": { "type": "string", "format": "uuid" }, "riskTreatmentPlanId": { "type": "string", "format": "uuid" }, "riskTreatmentPlanDueDate": { "type": "string", "format": "date-time" }, "riskTreatmentPlanNote": { "type": "string" }, "riskNistTypeId": { "type": "string", "format": "uuid" }, "riskNistCategoryId": { "type": "string", "format": "uuid" } } }, "FairRisk": { "required": [ "createdBy", "customerId", "formattedLossMagnitudeMax", "formattedLossMagnitudeMin", "formattedLossMagnitudeMostLikely", "id", "lastUpdatedBy", "lossFrequencyMaxEvents", "lossFrequencyMaxYears", "lossFrequencyMinEvents", "lossFrequencyMinYears", "lossFrequencyMostLikelyEvents", "lossFrequencyMostLikelyYears", "lossMagnitudeMax", "lossMagnitudeMin", "lossMagnitudeMostLikely", "name", "revision" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "lastUpdated": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "lossMagnitudeMin": { "type": "integer", "format": "int64" }, "lossMagnitudeMax": { "type": "integer", "format": "int64" }, "lossMagnitudeMostLikely": { "type": "integer", "format": "int64" }, "lossFrequencyDescription": { "type": "string" }, "lossMagnitudeDescription": { "type": "string" }, "lossFrequencyMinEvents": { "type": "number", "format": "double" }, "lossFrequencyMinYears": { "type": "number", "format": "double" }, "lossFrequencyMaxEvents": { "type": "number", "format": "double" }, "lossFrequencyMaxYears": { "type": "number", "format": "double" }, "lossFrequencyMostLikelyEvents": { "type": "number", "format": "double" }, "lossFrequencyMostLikelyYears": { "type": "number", "format": "double" }, "formattedLossMagnitudeMin": { "type": "string" }, "formattedLossMagnitudeMax": { "type": "string" }, "formattedLossMagnitudeMostLikely": { "type": "string" } } }, "UpdateExecutiveDashboardDto": { "required": [ "assessmentIds", "customerId", "frameworkIds", "organizationalUnitId", "riskIds", "riskRemediationDashboardIds", "riskRemediationProjectStatusIds", "tagIds" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "sectorId": { "type": "string", "format": "uuid" }, "employeeCount": { "maximum": 99999999, "type": "integer", "format": "int64" }, "revenue": { "maximum": 99999999999999, "type": "integer", "format": "int64" }, "riskDashboardMethodId": { "type": "string", "format": "uuid" }, "risksSelectedByCategory": { "type": "boolean" }, "addCreatedRisks": { "type": "boolean" }, "riskIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tagIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "frameworkIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskRemediationDashboardIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "advisenSecondaryIndustryId": { "type": "string", "format": "uuid" }, "riskRemediationProjectStatusIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "ExecutiveDashboardDto": { "required": [ "addCreatedRisks", "assessmentIds", "frameworkIds", "lastUpdatedAt", "organizationalUnitId", "riskIds", "riskRemediationDashboardIds", "riskRemediationProjectStatusIds", "risksSelectedByCategory", "tagIds", "validOrganizationalUnitIds" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "sectorId": { "type": "string", "format": "uuid" }, "employeeCount": { "type": "integer", "format": "int64" }, "revenue": { "type": "integer", "format": "int64" }, "riskDashboardMethodId": { "type": "string", "format": "uuid" }, "risksSelectedByCategory": { "type": "boolean" }, "addCreatedRisks": { "type": "boolean" }, "riskIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tagIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "frameworkIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "riskRemediationDashboardIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "advisenSecondaryIndustryId": { "type": "string", "format": "uuid" }, "riskRemediationProjectStatusIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "validOrganizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "CreateOrUpdateDataLakeTemplateRequest": { "required": [ "adHocEntries", "frameworkId", "name", "sourceId", "templatedEntries" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string" }, "frameworkId": { "type": "string", "format": "uuid" }, "sourceId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "adHocEntries": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeTemplateRequestAdHocEntry" } }, "templatedEntries": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeTemplateRequestTemplatedEntry" } } } }, "DataLakeTemplateRequestAdHocEntry": { "required": [ "controlActionId", "controlId", "database", "query", "schema", "sourceId" ], "type": "object", "properties": { "controlId": { "type": "string", "format": "uuid" }, "controlActionId": { "type": "string", "format": "uuid" }, "sourceId": { "type": "string", "format": "uuid" }, "query": { "type": "string" }, "database": { "type": "string" }, "schema": { "type": "string" }, "warehouse": { "type": "string" } } }, "DataLakeTemplateRequestTemplatedEntry": { "required": [ "controlActionId", "controlId", "params", "queryTemplateId" ], "type": "object", "properties": { "controlId": { "type": "string", "format": "uuid" }, "controlActionId": { "type": "string", "format": "uuid" }, "templatedQueryId": { "type": "string", "format": "uuid" }, "queryTemplateId": { "type": "string", "format": "uuid" }, "params": { "type": "object", "additionalProperties": { "type": "object" } } } }, "CreateOrUpdateDataLakeQueryTemplateRequest": { "required": [ "customerId", "database", "frameworkId", "name", "query", "schema", "sourceId" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "sourceId": { "type": "string", "format": "uuid" }, "frameworkId": { "type": "string", "format": "uuid" }, "query": { "type": "string" }, "database": { "maxLength": 255, "minLength": 0, "type": "string" }, "schema": { "maxLength": 255, "minLength": 0, "type": "string" }, "warehouse": { "maxLength": 255, "minLength": 0, "type": "string" }, "customerId": { "type": "string", "format": "uuid" } } }, "CyberInsightRiskRequestScore": { "required": [ "optionSetId" ], "type": "object", "properties": { "optionSetId": { "type": "string", "format": "uuid" }, "optionId": { "type": "string", "format": "uuid" }, "note": { "type": "string" } } }, "CyberInsightTemplateRequest": { "required": [ "controlIds", "name", "scores" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "scores": { "type": "array", "items": { "$ref": "#/components/schemas/CyberInsightRiskRequestScore" } }, "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "mitreTechniqueDtos": { "type": "array", "items": { "$ref": "#/components/schemas/MitreTechniqueDto" } } } }, "CyberInsightTemplate": { "required": [ "createdAt", "createdById", "customerId", "id", "name", "revision" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string", "format": "uuid" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "lastUpdatedById": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" } } }, "UpdateHistoricalDataTimeframeRequest": { "required": [ "historicalDataTimeframe" ], "type": "object", "properties": { "historicalDataTimeframe": { "type": "integer", "format": "int32" } } }, "CustomerDefaults": { "required": [ "assessmentWorkflowId", "controlWorkflowId", "customerId", "detectionWeight", "historicalDataTimeframe", "id", "preventionWeight", "responseWeight" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "controlWorkflowId": { "type": "string", "format": "uuid" }, "assessmentWorkflowId": { "type": "string", "format": "uuid" }, "detectionWeight": { "type": "number", "format": "double" }, "preventionWeight": { "type": "number", "format": "double" }, "responseWeight": { "type": "number", "format": "double" }, "historicalDataTimeframe": { "type": "integer", "format": "int32" }, "historicalDataTimeframeLastUpdated": { "type": "string", "format": "date-time" } } }, "UpdateControlWeightsRequest": { "required": [ "detectionWeight", "preventionWeight", "responseWeight" ], "type": "object", "properties": { "detectionWeight": { "type": "number", "format": "double" }, "preventionWeight": { "type": "number", "format": "double" }, "responseWeight": { "type": "number", "format": "double" } } }, "CustomerDashboardRequest": { "type": "object", "properties": { "sectorId": { "type": "string", "format": "uuid" }, "advisenSecondaryIndustryId": { "type": "string", "format": "uuid" }, "revenue": { "maximum": 99999999999999, "type": "integer", "format": "int64" }, "employeeCount": { "maximum": 99999999, "type": "integer", "format": "int64" } } }, "UpdateConfigRequest": { "required": [ "currency", "sessionTimeoutMinutes" ], "type": "object", "properties": { "currency": { "type": "string" }, "customerDashboard": { "$ref": "#/components/schemas/CustomerDashboardRequest" }, "jiraEnabled": { "type": "boolean" }, "jiraConfig": { "$ref": "#/components/schemas/CreateOrUpdateJiraConfigRequest" }, "sessionTimeoutMinutes": { "maximum": 60, "minimum": 15, "type": "integer", "format": "int32" }, "knightVisionEnabled": { "type": "boolean" } } }, "UpdateCustomReportTargetsRequest": { "required": [ "targetIds" ], "type": "object", "properties": { "targetIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "CrosswalkTemplateMappingRequestBody": { "required": [ "fromId", "isAccepted", "toId" ], "type": "object", "properties": { "fromId": { "type": "string", "format": "uuid" }, "toId": { "type": "string", "format": "uuid" }, "isAccepted": { "type": "boolean" } } }, "CrosswalkTemplateMappingDetails": { "required": [ "fromControlId", "fromFrameworkId", "fromId", "toControlId", "toFrameworkId", "toId" ], "type": "object", "properties": { "fromFrameworkId": { "type": "string", "format": "uuid" }, "fromId": { "type": "string", "format": "uuid" }, "toFrameworkId": { "type": "string", "format": "uuid" }, "toId": { "type": "string", "format": "uuid" }, "confidence": { "type": "number" }, "fromControlId": { "type": "string", "format": "uuid" }, "toControlId": { "type": "string", "format": "uuid" }, "fromControlActionId": { "type": "string", "format": "uuid" }, "toControlActionId": { "type": "string", "format": "uuid" }, "toControlActionIdx": { "type": "integer", "format": "int32" }, "isAccepted": { "type": "boolean" } } }, "ControlScoreActionAnnotation": { "required": [ "annotation", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "annotation": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "updatedById": { "type": "string", "format": "uuid" } } }, "AwsAuthenticationPart": { "required": [ "externalId", "region", "roleId" ], "type": "object", "properties": { "roleId": { "maxLength": 128, "minLength": 0, "type": "string" }, "externalId": { "maxLength": 64, "minLength": 0, "type": "string" }, "region": { "maxLength": 32, "minLength": 0, "type": "string" } } }, "AwsConnectorRequest": { "required": [ "description", "organizationalUnitId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectorRequest" }, { "type": "object", "properties": { "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "authentication": { "$ref": "#/components/schemas/AwsAuthenticationPart" }, "dataAuthentication": { "$ref": "#/components/schemas/DataAuthenticationPart" } } } ] }, "AzureAuthenticationPart": { "required": [ "clientId", "clientSecret", "managementGroup", "tenantId" ], "type": "object", "properties": { "clientId": { "maxLength": 255, "minLength": 0, "type": "string" }, "clientSecret": { "maxLength": 255, "minLength": 0, "type": "string" }, "tenantId": { "maxLength": 255, "minLength": 0, "type": "string" }, "managementGroup": { "maxLength": 255, "minLength": 0, "type": "string" } } }, "AzureConnectorRequest": { "required": [ "description", "organizationalUnitId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectorRequest" }, { "type": "object", "properties": { "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "authentication": { "$ref": "#/components/schemas/AzureAuthenticationPart" }, "dataAuthentication": { "$ref": "#/components/schemas/DataAuthenticationPart" } } } ] }, "ConnectorRequest": { "required": [ "description", "organizationalUnitId", "type" ], "type": "object", "properties": { "description": { "type": "string" }, "authentication": { "type": "object" }, "dataAuthentication": { "oneOf": [ { "$ref": "#/components/schemas/PostgresAuthenticationPart" }, { "$ref": "#/components/schemas/SnowflakeAuthenticationPart" } ] }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "type": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "DataAuthenticationPart": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "PostgresAuthenticationPart": { "required": [ "host", "password", "port" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DataAuthenticationPart" }, { "type": "object", "properties": { "host": { "maxLength": 255, "minLength": 0, "type": "string" }, "port": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32" }, "password": { "maxLength": 64, "minLength": 0, "type": "string" } } } ] }, "QualysAuthenticationPart": { "required": [ "password", "url", "username" ], "type": "object", "properties": { "url": { "maxLength": 255, "minLength": 0, "type": "string" }, "username": { "maxLength": 255, "minLength": 0, "type": "string" }, "password": { "maxLength": 255, "minLength": 0, "type": "string" } } }, "QualysConnectorRequest": { "required": [ "description", "organizationalUnitId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectorRequest" }, { "type": "object", "properties": { "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "authentication": { "$ref": "#/components/schemas/QualysAuthenticationPart" }, "dataAuthentication": { "$ref": "#/components/schemas/DataAuthenticationPart" } } } ] }, "SnowflakeAuthenticationPart": { "required": [ "account", "privateKey" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DataAuthenticationPart" }, { "type": "object", "properties": { "account": { "maxLength": 255, "minLength": 0, "type": "string" }, "privateKey": { "maxLength": 2048, "minLength": 0, "type": "string" } } } ] }, "Connector": { "required": [ "customerId", "dataSourceId", "description", "id", "organizationalUnitId", "sourceId" ], "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "sourceId": { "type": "string", "format": "uuid" }, "authentication": { "type": "object" }, "dataSourceId": { "type": "string", "format": "uuid" }, "dataAuthentication": { "$ref": "#/components/schemas/DataAuthentication" }, "customerId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "DataAuthentication": { "type": "object" }, "UpdateAwsIntegrationAuthenticationRequest": { "required": [ "description", "externalId", "id", "organizationalUnitId", "region", "roleId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "roleId": { "maxLength": 128, "minLength": 0, "type": "string" }, "externalId": { "maxLength": 64, "minLength": 0, "type": "string" }, "region": { "maxLength": 32, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "AwsSourceAuthentication": { "required": [ "authentication", "description", "id", "organizationalUnitId", "sourceId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "sourceId": { "type": "string", "format": "uuid" }, "authentication": { "$ref": "#/components/schemas/AwsSourceAuthenticationDetails" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "AwsSourceAuthenticationDetails": { "required": [ "externalId", "region", "roleId" ], "type": "object", "properties": { "roleId": { "type": "string" }, "region": { "type": "string" }, "externalId": { "type": "string" } } }, "SaveAuthenticationMethod": { "required": [ "id", "name", "organizationalUnitId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "passwordConfiguration": { "$ref": "#/components/schemas/SavePasswordAuthenticationMethodDetails" }, "oidcConfiguration": { "$ref": "#/components/schemas/SaveOidcAuthenticationMethodDetails" }, "samlConfiguration": { "$ref": "#/components/schemas/SaveSamlAuthenticationMethodDetails" } } }, "SaveOidcAuthenticationMethodDetails": { "required": [ "clientId", "issuerLocation" ], "type": "object", "properties": { "clientId": { "maxLength": 255, "minLength": 0, "type": "string" }, "issuerLocation": { "maxLength": 255, "minLength": 0, "type": "string" }, "clientSecret": { "type": "string" }, "groupClaim": { "type": "string" }, "domain": { "maxLength": 255, "minLength": 0, "type": "string" } } }, "SavePasswordAuthenticationMethodDetails": { "required": [ "loginLimit" ], "type": "object", "properties": { "loginLimit": { "type": "integer", "format": "int32" } } }, "SaveSamlAuthenticationMethodDetails": { "required": [ "authnRequestSigned", "entityId", "verificationCertificate", "webSsoUrl" ], "type": "object", "properties": { "entityId": { "maxLength": 255, "minLength": 0, "type": "string" }, "webSsoUrl": { "maxLength": 255, "minLength": 0, "type": "string" }, "verificationCertificate": { "type": "string" }, "groupAttribute": { "maxLength": 255, "minLength": 0, "type": "string" }, "authnRequestSigned": { "type": "boolean" }, "domain": { "maxLength": 255, "minLength": 0, "type": "string" } } }, "AuthenticationMethod": { "required": [ "authenticationType", "customerId", "id", "name", "organizationalUnitId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "authenticationType": { "type": "string", "enum": [ "SAML", "OIDC", "PASSWORD" ] } } }, "AssetTypeAttributeRequest": { "required": [ "id", "isFavorite", "isRequired" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "isFavorite": { "type": "boolean" }, "isRequired": { "type": "boolean" } } }, "AssetTypeRequest": { "required": [ "assetAttributes", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "assetAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/AssetTypeAttributeRequest" } } } }, "AssetType": { "required": [ "createdAt", "customerId", "id", "label" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string", "format": "uuid" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "lastUpdatedById": { "type": "string", "format": "uuid" } } }, "AssetGroupRequest": { "required": [ "name", "organizationalUnitId", "type" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "format": "uuid" }, "owners": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "selectedAssetAttributeAndValue": { "type": "array", "items": { "$ref": "#/components/schemas/SelectedAssetAttributeAndValue" } } } }, "SelectedAssetAttributeAndValue": { "required": [ "assetAttributeId" ], "type": "object", "properties": { "assetAttributeId": { "type": "string", "format": "uuid" }, "assetAttributeValue": { "type": "string" } } }, "AssetGroup": { "required": [ "assetTypeId", "createdAt", "createdById", "customerId", "id", "name", "organizationalUnitId", "revision" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "assetTypeId": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string", "format": "uuid" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "AssetAttributeListOptionUpdate": { "required": [ "option" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "option": { "maxLength": 255, "minLength": 1, "type": "string" } } }, "UpdateAssetAttributeRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "listOptions": { "type": "array", "items": { "$ref": "#/components/schemas/AssetAttributeListOptionUpdate" } } } }, "UpdateAssessmentWorkflowRequest": { "required": [ "assessmentWorkflowOptionId" ], "type": "object", "properties": { "assessmentWorkflowOptionId": { "type": "string", "format": "uuid" } } }, "Assessment": { "required": [ "active", "assessmentWorkflowOptionId", "currentScore", "customerId", "cyberstrongScore", "frameworkId", "id", "identifier", "name", "normalizedTargetScore", "organizationalUnitId", "percentComplete", "revision", "targetScore" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "identifier": { "type": "string" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "frameworkId": { "type": "string", "format": "uuid" }, "ownerId": { "type": "string", "format": "uuid" }, "currentScore": { "type": "number" }, "targetScore": { "type": "number" }, "percentComplete": { "type": "integer", "format": "int32" }, "maturityModel": { "type": "string" }, "cyberstrongScore": { "type": "integer", "format": "int32" }, "level": { "type": "integer", "format": "int32" }, "documentStorageLocation": { "type": "string" }, "normalizedTargetScore": { "type": "integer", "format": "int32" }, "assessmentWorkflowOptionId": { "type": "string", "format": "uuid" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "AssessmentImportResult": { "type": "object", "properties": { "message": { "type": "string" }, "column": { "type": "string" }, "row": { "type": "integer", "format": "int32" } } }, "AssessmentImportResults": { "required": [ "errors", "warnings" ], "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentImportResult" } }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentImportResult" } } } }, "ImportAssessmentResponse": { "required": [ "isSuccess", "result" ], "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "result": { "$ref": "#/components/schemas/AssessmentImportResults" }, "assessmentDto": { "$ref": "#/components/schemas/AssessmentDto" } } }, "UpdateDCMMMaturityRequest": { "required": [ "answer", "dcmmMaturityControlScoreId" ], "type": "object", "properties": { "dcmmMaturityControlScoreId": { "type": "string", "format": "uuid" }, "answer": { "type": "boolean" } } }, "DCMMMaturityItem": { "required": [ "dcmmMaturityEntryId", "id", "level", "question" ], "type": "object", "properties": { "level": { "type": "integer", "format": "int32" }, "answer": { "type": "boolean" }, "question": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "dcmmMaturityEntryId": { "type": "string", "format": "uuid" } } }, "DCMMMaturityModelModuleEntry": { "required": [ "levels", "name" ], "type": "object", "properties": { "levels": { "type": "array", "items": { "$ref": "#/components/schemas/DCMMMaturityItem" } }, "name": { "type": "string" }, "score": { "type": "integer", "format": "int32" } } }, "UpdateProjectRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "note": { "type": "string" }, "ownerId": { "type": "string", "format": "uuid" } } }, "ProjectDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "ownerId": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" }, "startedDate": { "type": "string", "format": "date-time" }, "completedDate": { "type": "string", "format": "date-time" }, "note": { "type": "string" }, "type": { "type": "string", "enum": [ "BASELINE", "BASELINE_WITH_RESET", "POAM", "SNAPSHOT" ] }, "createdById": { "type": "string", "format": "uuid" }, "createdBy": { "$ref": "#/components/schemas/UserDto" } } }, "MaturityUpdateRequest": { "required": [ "id", "score" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "score": { "type": "number", "format": "float" } } }, "MaturityModelLevel": { "required": [ "id", "label", "level", "levelId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "levelId": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "level": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "float" } } }, "MaturityModelModuleEntry": { "required": [ "levels", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "levels": { "type": "array", "items": { "$ref": "#/components/schemas/MaturityModelLevel" } }, "score": { "type": "integer", "format": "int32" } } }, "UpdateAssessmentAutomationRequest": { "required": [ "frequency", "paused" ], "type": "object", "properties": { "paused": { "type": "boolean" }, "frequency": { "type": "string", "enum": [ "Daily", "Weekly", "Monthly" ] }, "dayOfWeek": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "dayOfMonth": { "maximum": 28, "minimum": 1, "type": "integer", "format": "int32" } } }, "AutomatedAssessmentDefinitionAndPartsDto": { "required": [ "assessmentId", "connectorParts", "customerId", "dataLakeParts", "frequency", "id", "paused", "policyParts", "vulnScanParts" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" }, "paused": { "type": "boolean" }, "frequency": { "type": "string", "enum": [ "Daily", "Weekly", "Monthly" ] }, "dayOfWeek": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "dayOfMonth": { "type": "integer", "format": "int32" }, "connectorParts": { "type": "array", "items": { "$ref": "#/components/schemas/AutomatedAssessmentDefinitionConnectorPartDto" } }, "policyParts": { "type": "array", "items": { "$ref": "#/components/schemas/AutomatedAssessmentDefinitionPolicyPartDto" } }, "vulnScanParts": { "type": "array", "items": { "$ref": "#/components/schemas/AutomatedAssessmentDefinitionVulnScanPartDto" } }, "dataLakeParts": { "type": "array", "items": { "$ref": "#/components/schemas/AutomatedAssessmentDefinitionDataLakePartDto" } } } }, "AutomatedAssessmentDefinitionConnectorPartDto": { "required": [ "connectorId" ], "type": "object", "properties": { "connectorId": { "type": "string", "format": "uuid" }, "filters": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/BooleanArrayFilter" }, { "$ref": "#/components/schemas/BooleanFilter" }, { "$ref": "#/components/schemas/DecimalArrayFilter" }, { "$ref": "#/components/schemas/DecimalFilter" }, { "$ref": "#/components/schemas/DecimalsFilter" }, { "$ref": "#/components/schemas/IntegerArrayFilter" }, { "$ref": "#/components/schemas/IntegerFilter" }, { "$ref": "#/components/schemas/IntegersFilter" }, { "$ref": "#/components/schemas/StringArrayFilter" }, { "$ref": "#/components/schemas/StringFilter" }, { "$ref": "#/components/schemas/StringsFilter" } ] } } } }, "AutomatedAssessmentDefinitionDataLakePartDto": { "required": [ "dataLakeTemplateId", "dataLakeTemplateName", "integrationSourceId", "params" ], "type": "object", "properties": { "integrationSourceId": { "type": "string", "format": "uuid" }, "integrationSourceAuthenticationId": { "type": "string", "format": "uuid" }, "dataLakeTemplateId": { "type": "string", "format": "uuid" }, "dataLakeTemplateName": { "type": "string" }, "params": { "type": "object", "additionalProperties": { "type": "object" } } } }, "AutomatedAssessmentDefinitionPolicyPartDto": { "required": [ "integrationSourceId", "params", "policyTemplateId", "policyTemplateName" ], "type": "object", "properties": { "integrationSourceId": { "type": "string", "format": "uuid" }, "integrationSourceAuthenticationId": { "type": "string", "format": "uuid" }, "policyTemplateId": { "type": "string", "format": "uuid" }, "policyTemplateName": { "type": "string" }, "params": { "type": "object", "additionalProperties": { "type": "object" } } } }, "AutomatedAssessmentDefinitionVulnScanPartDto": { "required": [ "integrationSourceId", "params", "threshold", "vulnerabilityScanTemplateId", "vulnerabilityScanTemplateName" ], "type": "object", "properties": { "integrationSourceId": { "type": "string", "format": "uuid" }, "integrationSourceAuthenticationId": { "type": "string", "format": "uuid" }, "vulnerabilityScanTemplateId": { "type": "string", "format": "uuid" }, "vulnerabilityScanTemplateName": { "type": "string" }, "threshold": { "type": "integer", "format": "int32" }, "params": { "type": "object", "additionalProperties": { "type": "object" } } } }, "BooleanArrayFilter": { "required": [ "field", "fieldType", "operation", "table", "value" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "boolean" } } } } ] }, "BooleanFilter": { "required": [ "field", "fieldType", "operation", "table", "value" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "type": "object", "properties": { "value": { "type": "boolean" } } } ] }, "DecimalArrayFilter": { "required": [ "field", "fieldType", "operation", "table", "value" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "number", "format": "double" } } } } ] }, "DecimalFilter": { "required": [ "field", "fieldType", "operation", "table", "value" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "type": "object", "properties": { "value": { "type": "number", "format": "double" } } } ] }, "DecimalsFilter": { "required": [ "field", "fieldType", "operation", "table", "value" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "number", "format": "double" } } } } ] }, "Filter": { "required": [ "field", "fieldType", "operation", "table", "type", "value" ], "type": "object", "properties": { "operation": { "type": "string", "enum": [ "EQUALS", "NOT_EQUALS", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUALS", "LESS_THAN_OR_EQUALS", "INCLUDES", "NOT_INCLUDES", "HAS_VALUE_IN" ] }, "value": { "type": "object" }, "field": { "type": "string" }, "fieldType": { "type": "string", "enum": [ "BOOLEAN", "INTEGER", "DECIMAL", "VARCHAR", "OBJECT", "BOOLEAN_ARRAY", "INTEGER_ARRAY", "DECIMAL_ARRAY", "VARCHAR_ARRAY", "OBJECT_ARRAY" ] }, "table": { "type": "string", "enum": [ "ASSETS", "POLICIES", "FINDINGS" ] }, "type": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "IntegerArrayFilter": { "required": [ "field", "fieldType", "operation", "table", "value" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } ] }, "IntegerFilter": { "required": [ "field", "fieldType", "operation", "table", "value" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" } } } ] }, "IntegersFilter": { "required": [ "field", "fieldType", "operation", "table", "value" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } ] }, "StringArrayFilter": { "required": [ "field", "fieldType", "operation", "table", "value" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string" } } } } ] }, "StringFilter": { "required": [ "field", "fieldType", "operation", "table", "value" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "type": "object", "properties": { "value": { "type": "string" } } } ] }, "StringsFilter": { "required": [ "field", "fieldType", "operation", "table", "value" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string" } } } } ] }, "UpdateAssessmentAutomationConnectorFiltersRequest": { "required": [ "filters" ], "type": "object", "properties": { "filters": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/BooleanArrayFilter" }, { "$ref": "#/components/schemas/BooleanFilter" }, { "$ref": "#/components/schemas/DecimalArrayFilter" }, { "$ref": "#/components/schemas/DecimalFilter" }, { "$ref": "#/components/schemas/DecimalsFilter" }, { "$ref": "#/components/schemas/IntegerArrayFilter" }, { "$ref": "#/components/schemas/IntegerFilter" }, { "$ref": "#/components/schemas/IntegersFilter" }, { "$ref": "#/components/schemas/StringArrayFilter" }, { "$ref": "#/components/schemas/StringFilter" }, { "$ref": "#/components/schemas/StringsFilter" } ] } } } }, "UpdateInstanceRequest": { "required": [ "customerId", "customerName", "selectedPackage", "userEmail", "userFirstName", "userId", "userLastName" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "customerName": { "maxLength": 100, "minLength": 2, "type": "string" }, "userId": { "type": "string", "format": "uuid" }, "userFirstName": { "maxLength": 255, "minLength": 0, "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "userLastName": { "maxLength": 255, "minLength": 0, "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "userEmail": { "maxLength": 255, "minLength": 0, "type": "string" }, "selectedPackage": { "pattern": "^(Trial|Compliance|Risk|Executive)$", "type": "string" }, "selectedAddOns": { "type": "array", "items": { "type": "string" } } } }, "SummaryResponse": { "required": [ "active", "customerId", "customerName", "urlToken", "userEmail", "userFirstName", "userId", "userLastName" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "customerName": { "type": "string" }, "active": { "type": "boolean" }, "urlToken": { "type": "string" }, "userId": { "type": "string", "format": "uuid" }, "userFirstName": { "type": "string" }, "userLastName": { "type": "string" }, "userEmail": { "type": "string" } } }, "ChangeActiveStatusRequest": { "required": [ "customerId" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" } } }, "ControlActionPresetDto": { "required": [ "controlActionId", "frameworkId" ], "type": "object", "properties": { "controlActionId": { "type": "string", "format": "uuid" }, "frameworkId": { "type": "string", "format": "uuid" }, "currentScoreModelValueId": { "type": "string", "format": "uuid" }, "targetScoreModelValueId": { "type": "string", "format": "uuid" } } }, "ControlPresetDto": { "required": [ "controlId", "frameworkId" ], "type": "object", "properties": { "controlId": { "type": "string", "format": "uuid" }, "frameworkId": { "type": "string", "format": "uuid" }, "currentScore": { "type": "number", "format": "double" }, "targetScore": { "type": "number", "format": "double" }, "controlActionPresets": { "type": "array", "items": { "$ref": "#/components/schemas/ControlActionPresetDto" } } } }, "CreateScoreGuidanceRequest": { "required": [ "description", "scoreGuidance" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "scoreGuidance": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreGuidanceEntryCreateRequest" } } } }, "ScoreGuidanceEntryCreateRequest": { "required": [ "guidanceText", "title" ], "type": "object", "properties": { "title": { "type": "string" }, "guidanceText": { "type": "string" } } }, "ScheduledJob": { "required": [ "description", "enabled", "id", "jobType", "name", "schedule" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "jobType": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "schedule": { "type": "string" } } }, "ScheduledJobSettings": { "required": [ "id", "notificationEmail" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "notificationEmail": { "type": "string" } } }, "ReportType": { "required": [ "customerIds", "description", "docType", "frameworkIds", "frameworkTypes", "globalCustomer", "globalFramework", "isMostCommon", "name", "pattern", "useCase" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "useCase": { "type": "string" }, "pattern": { "type": "string" }, "docType": { "type": "string" }, "isMostCommon": { "type": "boolean" }, "globalCustomer": { "type": "boolean" }, "globalFramework": { "type": "boolean" }, "customerIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "frameworkIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "frameworkTypes": { "type": "array", "items": { "type": "string" } } } }, "UpdateFrameworkRequestAdmin": { "required": [ "assessmentCharts", "csfWeighted", "cybersecurityFrameworkId", "name", "type", "version" ], "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "Regulatory", "Binary" ] }, "parentId": { "type": "string", "format": "uuid" }, "cybersecurityFrameworkId": { "type": "string", "format": "uuid" }, "csfWeighted": { "type": "boolean" }, "assessmentCharts": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "ReorderControlRequest": { "required": [ "controlIds", "frameworkId" ], "type": "object", "properties": { "frameworkId": { "type": "string", "format": "uuid" }, "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "RemoveControlFromFrameworkRequest": { "required": [ "controlId", "frameworkId" ], "type": "object", "properties": { "controlId": { "type": "string", "format": "uuid" }, "frameworkId": { "type": "string", "format": "uuid" } } }, "AddControlsByFrameworkRequest": { "required": [ "frameworkId" ], "type": "object", "properties": { "frameworkId": { "type": "string", "format": "uuid" } } }, "AddControlToFrameworkRequest": { "required": [ "controlId" ], "type": "object", "properties": { "controlId": { "type": "string", "format": "uuid" } } }, "UpdateCustomerRequest": { "required": [ "blacklistEmails", "name", "prefix", "urlToken" ], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 2, "type": "string" }, "urlToken": { "maxLength": 100, "minLength": 1, "pattern": "([a-z_0-9\\-]+)?", "type": "string" }, "prefix": { "maxLength": 3, "minLength": 3, "pattern": "([A-Z0-9]+)?", "type": "string" }, "blacklistEmails": { "type": "boolean" }, "selectedPackageId": { "type": "string", "format": "uuid" }, "selectedFeatures": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "Customer": { "required": [ "active", "blacklistEmails", "hasGlobalAdministrators", "id", "knightVisionEnabled", "lastUpdated", "maxInactiveSessionIntervalSeconds", "name", "prefix", "revision", "urlToken" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "urlToken": { "type": "string" }, "hasGlobalAdministrators": { "type": "boolean" }, "userId": { "type": "string", "format": "uuid" }, "currency": { "type": "string" }, "createdById": { "type": "string", "format": "uuid" }, "updatedById": { "type": "string", "format": "uuid" }, "blacklistEmails": { "type": "boolean" }, "prefix": { "type": "string" }, "maxInactiveSessionIntervalSeconds": { "type": "integer", "format": "int32" }, "productPackageId": { "type": "string", "format": "uuid" }, "knightVisionEnabled": { "type": "boolean" } } }, "ControlActionRequest": { "required": [ "content" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "level": { "type": "integer", "format": "int32" }, "scoreModelValueSetId": { "type": "string", "format": "uuid" }, "idx": { "type": "integer", "format": "int32" } } }, "ControlCatalogDto": { "required": [ "id", "name", "version" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "version": { "type": "string" }, "description": { "type": "string" } } }, "ControlRequestData": { "required": [ "controlActions", "controlCatalogs", "controlFamily", "controlLabel", "parentControlLabel", "sp80053Controls", "subcategories" ], "type": "object", "properties": { "controlFamily": { "maxLength": 150, "minLength": 0, "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "controlLabel": { "maxLength": 150, "minLength": 0, "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "parentControlLabel": { "maxLength": 250, "minLength": 0, "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "description": { "type": "string" }, "remediationCost": { "minimum": 0, "type": "integer", "format": "int32" }, "remediationImpact": { "minimum": 0, "type": "integer", "format": "int32" }, "auxiliaryControlLabel": { "type": "string" }, "complianceDescription": { "type": "string" }, "evidenceRequired": { "type": "string" }, "remediationSteps": { "type": "string" }, "supplementalGuidance": { "type": "string" }, "level": { "type": "integer", "format": "int32" }, "scoreModelValueSetId": { "type": "string", "format": "uuid" }, "controlCatalogs": { "type": "array", "items": { "$ref": "#/components/schemas/ControlCatalogDto" } }, "subcategories": { "type": "array", "items": { "type": "string" } }, "sp80053Controls": { "type": "array", "items": { "$ref": "#/components/schemas/Sp80053Control" } }, "controlActions": { "type": "array", "items": { "$ref": "#/components/schemas/ControlActionRequest" } }, "params": { "$ref": "#/components/schemas/ControlParameters" } } }, "Sp80053Control": { "required": [ "controlFamily", "controlLabel", "description", "id", "parentControlLabel" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "controlFamily": { "type": "string" }, "controlLabel": { "type": "string" }, "parentControlLabel": { "type": "string" }, "auxiliaryControlLabel": { "type": "string" }, "description": { "type": "string" }, "complianceDescription": { "type": "string" }, "supplementalGuidance": { "type": "string" } } }, "ControlDto": { "required": [ "active", "controlActions", "controlCatalogs", "controlFamily", "controlLabel", "description", "isSystem", "parentControlLabel", "revision", "sp80053Controls", "subcategories" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "controlFamily": { "type": "string" }, "controlLabel": { "type": "string" }, "parentControlLabel": { "type": "string" }, "auxiliaryControlLabel": { "type": "string" }, "description": { "type": "string" }, "supplementalGuidance": { "type": "string" }, "evidenceRequired": { "type": "string" }, "remediationCost": { "type": "integer", "format": "int32" }, "remediationImpact": { "type": "integer", "format": "int32" }, "remediationSteps": { "type": "string" }, "complianceDescription": { "type": "string" }, "isSystem": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "scoreModelValueSetId": { "type": "string", "format": "uuid" }, "controlCatalogs": { "type": "array", "items": { "$ref": "#/components/schemas/ControlCatalogDto" } }, "subcategories": { "type": "array", "items": { "type": "string" } }, "sp80053Controls": { "type": "array", "items": { "$ref": "#/components/schemas/Sp80053Control" } }, "controlActions": { "type": "array", "items": { "$ref": "#/components/schemas/ControlActionDto" } }, "params": { "$ref": "#/components/schemas/ControlParameters" } } }, "UserGroupRequest": { "required": [ "groupIds", "operation" ], "type": "object", "properties": { "operation": { "pattern": "^(add|remove)$", "type": "string" }, "groupIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "UserGroupResult": { "required": [ "groupId", "message" ], "type": "object", "properties": { "message": { "type": "string" }, "groupId": { "type": "string", "format": "uuid" } } }, "UserGroupResults": { "required": [ "userId", "warnings" ], "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupResult" } } } }, "CreateTenableIntegrationAuthenticationRequest": { "required": [ "accessKey", "description", "organizationalUnitId", "secretKey", "url" ], "type": "object", "properties": { "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "url": { "maxLength": 255, "minLength": 0, "type": "string" }, "accessKey": { "maxLength": 64, "minLength": 0, "type": "string" }, "secretKey": { "maxLength": 64, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "TenableSourceAuthenticationDetailsSecure": { "required": [ "accessKey", "url" ], "type": "object", "properties": { "url": { "type": "string" }, "accessKey": { "type": "string" } } }, "TenableSourceAuthenticationSecure": { "required": [ "authentication", "description", "id", "organizationalUnitId", "sourceId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "sourceId": { "type": "string", "format": "uuid" }, "authentication": { "$ref": "#/components/schemas/TenableSourceAuthenticationDetailsSecure" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "ScoreModelRequestData": { "required": [ "isValid", "name", "values" ], "type": "object", "properties": { "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreModelRequestValue" } }, "isValid": { "type": "boolean" } } }, "ScoreModelRequestValue": { "required": [ "label", "order", "value" ], "type": "object", "properties": { "label": { "maxLength": 50, "minLength": 0, "type": "string" }, "value": { "type": "number", "format": "double" }, "description": { "type": "string" }, "order": { "type": "integer", "format": "int32" } } }, "CreateSnowflakeIntegrationAuthenticationRequest": { "required": [ "account", "description", "organizationalUnitId", "privateKey", "role", "user", "warehouse" ], "type": "object", "properties": { "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "account": { "maxLength": 255, "minLength": 0, "type": "string" }, "user": { "maxLength": 255, "minLength": 0, "type": "string" }, "privateKey": { "maxLength": 2048, "minLength": 0, "type": "string" }, "warehouse": { "maxLength": 255, "minLength": 0, "type": "string" }, "role": { "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "SaveSnowflakePushConfigRequest": { "required": [ "account", "privateKey" ], "type": "object", "properties": { "account": { "maxLength": 255, "minLength": 0, "type": "string" }, "privateKey": { "maxLength": 2048, "minLength": 0, "type": "string" } } }, "SnowflakePushConfigSecure": { "required": [ "account", "customerId" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "account": { "type": "string" } } }, "AddOrRemovePermissionRequest": { "required": [ "permissionId" ], "type": "object", "properties": { "permissionId": { "type": "string", "format": "uuid" } } }, "CreateRisksFromTemplatesRequest": { "required": [ "assessmentIds", "riskRegisterId", "riskTemplateIds" ], "type": "object", "properties": { "riskRegisterId": { "type": "string", "format": "uuid" }, "assessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskTemplateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "Pageable": { "type": "object", "properties": { "page": { "minimum": 0, "type": "integer", "format": "int32" }, "size": { "minimum": 1, "type": "integer", "format": "int32" }, "sort": { "type": "array", "items": { "type": "string" } } } }, "GlobalControlsQueryParams": { "required": [ "existingControls" ], "type": "object", "properties": { "existingControls": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "search": { "type": "string" }, "controlType": { "type": "string" }, "frameworkIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "GlobalRiskControl": { "required": [ "active", "assessments", "controlFamily", "controlLabel", "fairCamControlTypes", "frameworks", "id", "revision" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "controlFamily": { "type": "string" }, "controlLabel": { "type": "string" }, "parentControlLabel": { "type": "string" }, "auxiliaryControlLabel": { "type": "string" }, "description": { "type": "string" }, "supplementalGuidance": { "type": "string" }, "evidenceRequired": { "type": "string" }, "remediationSteps": { "type": "string" }, "remediationCost": { "type": "integer", "format": "int32" }, "remediationImpact": { "type": "integer", "format": "int32" }, "complianceDescription": { "type": "string" }, "assessments": { "type": "array", "items": { "type": "string" } }, "frameworks": { "type": "array", "items": { "type": "string" } }, "fairCamControlTypes": { "type": "array", "items": { "type": "string" } } } }, "PageGlobalRiskControl": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalRiskControl" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "PageableObject": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int64" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "paged": { "type": "boolean" }, "unpaged": { "type": "boolean" } } }, "SortObject": { "type": "object", "properties": { "empty": { "type": "boolean" }, "sorted": { "type": "boolean" }, "unsorted": { "type": "boolean" } } }, "CreateBahRiskRequest": { "required": [ "controlIds", "controlScoreIds", "mitreTechniqueDtos", "risk", "riskRegisterId", "scores" ], "type": "object", "properties": { "riskRegisterId": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" }, "risk": { "$ref": "#/components/schemas/SimpleRiskRequest" }, "scores": { "type": "array", "items": { "$ref": "#/components/schemas/BahRiskRequestScore" } }, "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlScoreIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "mitreTechniqueDtos": { "type": "array", "items": { "$ref": "#/components/schemas/MitreTechniqueDto" } }, "treatmentPlanSelectedOptionId": { "type": "string", "format": "uuid" }, "treatmentPlanDueDate": { "type": "string", "format": "date-time" }, "treatmentPlanNote": { "type": "string" }, "templateId": { "type": "string", "format": "uuid" } } }, "ControlIdsRequest": { "required": [ "controlIds" ], "type": "object", "properties": { "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "ControlCsfFunctions": { "required": [ "control", "isRestricted" ], "type": "object", "properties": { "control": { "$ref": "#/components/schemas/Control" }, "isRestricted": { "type": "boolean" }, "controlScore": { "$ref": "#/components/schemas/ControlScore" }, "csfFunctions": { "type": "array", "items": { "$ref": "#/components/schemas/CsfFunction" } } } }, "ControlScore": { "required": [ "active", "assessmentId", "businessImpact", "collaboratorIds", "controlId", "createdAt", "customerId", "excludeFromScore", "id", "isFlagged", "responsibleRoles", "revision", "threatType" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "assessmentId": { "type": "string", "format": "uuid" }, "controlId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "isFlagged": { "type": "boolean" }, "currentCompliance": { "type": "number", "format": "float" }, "assignedTo": { "type": "string", "format": "uuid" }, "updatedById": { "type": "string", "format": "uuid" }, "riskImpact": { "type": "integer", "format": "int32" }, "riskLikelihood": { "type": "integer", "format": "int32" }, "targetScore": { "type": "number", "format": "float" }, "dataProtection": { "type": "string", "enum": [ "Confidentiality", "Integrity", "Availability" ] }, "threatType": { "type": "array", "items": { "type": "string", "enum": [ "Adversarial", "Accidental", "Environmental", "Structural" ] } }, "businessImpact": { "type": "array", "items": { "type": "string", "enum": [ "Financial", "Operational", "Reputational", "Regulatory and Legal" ] } }, "dueDate": { "type": "string", "format": "date-time" }, "dueDateRecurrence": { "type": "string", "enum": [ "MONTHLY", "QUARTERLY", "YEARLY" ] }, "collaboratorIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "financialImpactMin": { "type": "integer", "format": "int32" }, "financialImpactMax": { "type": "integer", "format": "int32" }, "financialImpactMostLikely": { "type": "integer", "format": "int32" }, "completionCostValue": { "type": "integer", "format": "int32" }, "maturityScore": { "type": "number", "format": "double" }, "normalizedCurrentCompliance": { "type": "number", "format": "double" }, "normalizedTargetScore": { "type": "number", "format": "double" }, "controlWorkflowOptionDefId": { "type": "string", "format": "uuid" }, "excludeFromScore": { "type": "boolean" }, "responsibleRoles": { "type": "array", "items": { "type": "string" } }, "controlOrigination": { "type": "string" }, "paramValues": { "type": "object", "additionalProperties": { "type": "string" } }, "flagged": { "type": "boolean", "writeOnly": true } } }, "CsfFunction": { "required": [ "id", "name", "uniqueIdentifier" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "uniqueIdentifier": { "type": "string" } } }, "RiskRemediationControlsFilters": { "type": "object", "properties": { "controlControlName": { "type": "string" }, "controlAssessments": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlCsfFunctions": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlCsfCategories": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "excludeControlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "includeDisabledControlScore": { "type": "boolean" } } }, "PageImplControlCsfFunctions": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/ControlCsfFunctions" } }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "last": { "type": "boolean" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "AssessmentControlsQueryParams": { "required": [ "includeDisabledControlScore" ], "type": "object", "properties": { "search": { "type": "string" }, "controlType": { "type": "string" }, "existingAssessmentControlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "includeDisabledControlScore": { "type": "boolean" }, "validOrganizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "ControlLabelDto": { "required": [ "controlFamily", "controlLabel", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "auxiliaryControlLabel": { "type": "string" }, "controlLabel": { "type": "string" }, "controlFamily": { "type": "string" }, "parentControlLabel": { "type": "string" } } }, "ControlScoreLabelDto": { "required": [ "controlLabel", "controlScore", "fairCamControlTypes", "frameworkId", "identifier", "isRestricted", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "frameworkId": { "type": "string", "format": "uuid" }, "isRestricted": { "type": "boolean" }, "controlLabel": { "$ref": "#/components/schemas/ControlLabelDto" }, "controlScore": { "$ref": "#/components/schemas/ControlScore" }, "fairCamControlTypes": { "type": "array", "items": { "type": "string" } } } }, "PageControlScoreLabelDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreLabelDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "GetControlScoresForRisksRequest": { "required": [ "remediationDashboardId", "riskIds" ], "type": "object", "properties": { "remediationDashboardId": { "type": "string", "format": "uuid" }, "riskIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlScoreIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlScoreActionIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskRemediationProjectId": { "type": "string", "format": "uuid" } } }, "ControlAssociatedRisksFilters": { "type": "object", "properties": { "riskControlsName": { "type": "string" }, "riskControlsCsfFunctions": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskControlsCsfCategories": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskControlsAssessments": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskControlsOrganizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "ControlAction": { "required": [ "active", "content", "controlId", "createdAt", "id", "lastUpdated", "revision" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "content": { "type": "string" }, "controlId": { "type": "string", "format": "uuid" }, "idx": { "type": "integer", "format": "int32" }, "level": { "type": "integer", "format": "int32" }, "scoreModelValueSetId": { "type": "string", "format": "uuid" } } }, "ControlScoreAction": { "required": [ "active", "controlActionId", "controlScoreId", "createdAt", "excludeFromScore", "id", "isAutomated", "revision" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "updatedById": { "type": "string", "format": "uuid" }, "controlActionId": { "type": "string", "format": "uuid" }, "controlScoreId": { "type": "string", "format": "uuid" }, "currentScoreModelValueId": { "type": "string", "format": "uuid" }, "targetScoreModelValueId": { "type": "string", "format": "uuid" }, "userResponsibilityScoreModelValueId": { "type": "string", "format": "uuid" }, "excludeFromScore": { "type": "boolean" }, "controlScoreActionAnnotationId": { "type": "string", "format": "uuid" }, "isAutomated": { "type": "boolean" }, "automationResultState": { "type": "string", "enum": [ "FAIL", "PARTIAL", "PASS", "NOT_APPLICABLE", "NOT_FOUND" ] }, "implementationDetails": { "type": "string" }, "implementationStatus": { "type": "string" }, "implementationStatusRemarks": { "type": "string" } } }, "Framework": { "required": [ "active", "assessmentScoreMethod", "controlScoreMethod", "csfWeighted", "customScoringModel", "cybersecurityFrameworkId", "id", "isPublic", "name", "revision", "sspEnabled", "status", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "version": { "maxLength": 255, "minLength": 0, "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "type": { "maxLength": 100, "minLength": 0, "type": "string", "enum": [ "Regulatory", "Binary" ] }, "description": { "type": "string" }, "status": { "maxLength": 50, "minLength": 0, "type": "string", "enum": [ "Draft", "Published", "Disabled" ] }, "parentId": { "type": "string", "format": "uuid" }, "customScoringModel": { "type": "string", "format": "uuid" }, "levelModelId": { "type": "string", "format": "uuid" }, "cybersecurityFrameworkId": { "type": "string", "format": "uuid" }, "controlScoreMethod": { "type": "string", "enum": [ "BINARY", "LEVEL", "REGULATORY", "CMMC_2" ] }, "assessmentScoreMethod": { "type": "string", "enum": [ "DFARS_171A", "RAW_CONTROL_FAMILY", "RAW_LEVELED_CONTROL_FAMILY", "RAW_PARENT_CONTROL_LABEL", "RAW", "CONTROL_FAMILY", "PARENT_CONTROL_LABEL", "CYBERSTRONG", "CMMC_2" ] }, "csfWeighted": { "type": "boolean" }, "supplementalScoreModelId": { "type": "string", "format": "uuid" }, "controlWorkflowGroupDefId": { "type": "string", "format": "uuid" }, "sspEnabled": { "type": "boolean" }, "assessmentWorkflowGroupId": { "type": "string", "format": "uuid" }, "isPublic": { "type": "boolean" } } }, "PageImplRemediationControlScoreSummary": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/RemediationControlScoreSummary" } }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "last": { "type": "boolean" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "RemediationControlScoreSummary": { "required": [ "assessment", "control", "controlScore", "framework" ], "type": "object", "properties": { "controlScore": { "$ref": "#/components/schemas/ControlScore" }, "control": { "$ref": "#/components/schemas/Control" }, "assessment": { "$ref": "#/components/schemas/Assessment" }, "framework": { "$ref": "#/components/schemas/Framework" }, "scoreModel": { "$ref": "#/components/schemas/ScoreModel" }, "isRestricted": { "type": "boolean" }, "hasNoControlAccess": { "type": "boolean" }, "isTargetRestricted": { "type": "boolean" }, "controlActions": { "type": "array", "items": { "$ref": "#/components/schemas/ControlAction" } }, "controlScoreActions": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreAction" } }, "scoreModelValues": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreModelValue" } } } }, "InherentResidualRequest": { "required": [ "controlScoreActionTargets", "riskIds", "totalCost" ], "type": "object", "properties": { "riskIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlScoreActionTargets": { "type": "array", "items": { "$ref": "#/components/schemas/RemediationControlTarget" } }, "totalCost": { "type": "number" } } }, "InherentResidualRiskData": { "required": [ "overallInherentRisk", "overallResidualRisk", "riskReductionPercentage", "rosi" ], "type": "object", "properties": { "overallInherentRisk": { "type": "number" }, "overallResidualRisk": { "type": "number" }, "riskReductionPercentage": { "type": "number" }, "rosi": { "type": "number" } } }, "CsfDataCategoryOption": { "required": [ "title", "value" ], "type": "object", "properties": { "title": { "type": "string" }, "value": { "type": "string", "format": "uuid" } } }, "CsfDataFunctionOption": { "required": [ "title", "value" ], "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/components/schemas/CsfDataCategoryOption" } }, "title": { "type": "string" }, "value": { "type": "string", "format": "uuid" } } }, "RiskRemediationCsfFunctionsRequest": { "required": [ "controlIds" ], "type": "object", "properties": { "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "ControlIdAndCsfSubcategory": { "required": [ "controlId", "subcategories" ], "type": "object", "properties": { "controlId": { "type": "string", "format": "uuid" }, "subcategories": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "RiskControlsCsfCoverage": { "required": [ "csfCategoryId" ], "type": "object", "properties": { "csfCategoryId": { "type": "string", "format": "uuid" }, "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "csfSubcategoryIds": { "type": "array", "items": { "type": "string" } } } }, "CsfCategory": { "required": [ "id", "name", "uniqueIdentifier" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "uniqueIdentifier": { "type": "string" } } }, "CsfDataAndControlScores": { "required": [ "csfCategory", "csfFunction" ], "type": "object", "properties": { "csfFunction": { "$ref": "#/components/schemas/CsfFunction" }, "csfCategory": { "$ref": "#/components/schemas/CsfCategory" }, "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScore" } }, "averageScore": { "type": "number", "format": "double" } } }, "RiskRemediationProjectStep3Data": { "required": [ "csfDataAndControlScores", "unassociatedIds" ], "type": "object", "properties": { "csfDataAndControlScores": { "type": "array", "items": { "$ref": "#/components/schemas/CsfDataAndControlScores" } }, "unassociatedIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "GetControlScoresForControlsRequest": { "required": [ "assessmentIds", "controlIds" ], "type": "object", "properties": { "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "ControlAssessmentsControlScores": { "required": [ "assessments", "control", "controlScores", "frameworks" ], "type": "object", "properties": { "control": { "$ref": "#/components/schemas/Control" }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/Assessment" } }, "frameworks": { "type": "array", "items": { "$ref": "#/components/schemas/Framework" } }, "controlScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScore" } }, "averageScore": { "type": "number", "format": "double" }, "averageNormalizedScore": { "type": "number", "format": "double" }, "isRestricted": { "type": "boolean" } } }, "PageImplControlAssessmentsControlScores": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/ControlAssessmentsControlScores" } }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "last": { "type": "boolean" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "GetAverageScoreForControlsRequest": { "required": [ "assessmentIds", "controlIds" ], "type": "object", "properties": { "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "GetControlScoreActionRequest": { "required": [ "controlScoreActionIds", "controlScoreIds", "remediationDashboardId" ], "type": "object", "properties": { "remediationDashboardId": { "type": "string", "format": "uuid" }, "controlScoreActionIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlScoreIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "ControlAssociatedRisks": { "required": [ "control" ], "type": "object", "properties": { "control": { "$ref": "#/components/schemas/Control" }, "risks": { "type": "array", "items": { "$ref": "#/components/schemas/Risk" } }, "frameworks": { "type": "array", "items": { "$ref": "#/components/schemas/Framework" } }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/Assessment" } }, "controlScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScore" } }, "csfFunctions": { "type": "array", "items": { "$ref": "#/components/schemas/CsfFunction" } }, "csfCategories": { "type": "array", "items": { "$ref": "#/components/schemas/CsfCategory" } }, "csfSubcategories": { "type": "array", "items": { "$ref": "#/components/schemas/CsfSubcategory" } }, "averageScore": { "type": "number", "format": "float" }, "averageNormalizedScore": { "type": "integer", "format": "int32" }, "isRestricted": { "type": "boolean" }, "controlActions": { "type": "array", "items": { "$ref": "#/components/schemas/ControlAction" } }, "controlScoreActions": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreAction" } }, "scoreModelValues": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreModelValue" } } } }, "CsfSubcategory": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" } } }, "PageImplControlAssociatedRisks": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/ControlAssociatedRisks" } }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "last": { "type": "boolean" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "GetControlScoresForRiskControlsRequest": { "required": [ "controlIds" ], "type": "object", "properties": { "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "RiskRemediationAssessment": { "required": [ "assessments", "controlId" ], "type": "object", "properties": { "controlId": { "type": "string", "format": "uuid" }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/Assessment" } } } }, "GetControlScoresForAssessmentRequest": { "required": [ "assessmentIds" ], "type": "object", "properties": { "assessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlScoreIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlScoreActionIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "RiskRemediationDashboardRequest": { "required": [ "name", "organizationalUnitId" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "RiskRemediationDashboard": { "required": [ "createdAt", "customerId", "id", "lastUpdated", "name", "organizationalUnitId", "revision" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "updatedById": { "type": "string", "format": "uuid" }, "createdById": { "type": "string", "format": "uuid" } } }, "RiskRegisterRequest": { "required": [ "isValid", "name", "organizationalUnitId", "riskRegisterMethodId" ], "type": "object", "properties": { "name": { "type": "string" }, "riskRegisterMethodId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" }, "riskModelId": { "type": "string", "format": "uuid" }, "assetGroups": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "isValid": { "type": "boolean" } } }, "RiskRegisterXAdvisenSectors": { "required": [ "assessmentId", "createdAt", "createdBy", "employeeCount", "revenue", "riskRegisterId", "sectorId" ], "type": "object", "properties": { "riskRegisterId": { "type": "string", "format": "uuid" }, "sectorId": { "type": "string", "format": "uuid" }, "revenue": { "type": "integer", "format": "int64" }, "employeeCount": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" }, "advisenSecondaryIndustryId": { "type": "string", "format": "uuid" } } }, "CreateQualysIntegrationAuthenticationRequest": { "required": [ "description", "organizationalUnitId", "password", "url", "username" ], "type": "object", "properties": { "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "url": { "maxLength": 64, "minLength": 0, "type": "string" }, "username": { "maxLength": 64, "minLength": 0, "type": "string" }, "password": { "maxLength": 64, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "QualysSourceAuthenticationDetailsSecure": { "required": [ "url", "username" ], "type": "object", "properties": { "url": { "type": "string" }, "username": { "type": "string" } } }, "QualysSourceAuthenticationSecure": { "required": [ "authentication", "description", "id", "organizationalUnitId", "sourceId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "sourceId": { "type": "string", "format": "uuid" }, "authentication": { "$ref": "#/components/schemas/QualysSourceAuthenticationDetailsSecure" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "CreatePostgresIntegrationAuthenticationRequest": { "required": [ "database", "description", "host", "organizationalUnitId", "password", "port", "user" ], "type": "object", "properties": { "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "host": { "maxLength": 255, "minLength": 0, "type": "string" }, "database": { "maxLength": 255, "minLength": 0, "type": "string" }, "port": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32" }, "user": { "maxLength": 255, "minLength": 0, "type": "string" }, "password": { "maxLength": 64, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "PostgresSourceAuthenticationDetailsSecure": { "required": [ "database", "host", "password", "port", "user" ], "type": "object", "properties": { "host": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "database": { "type": "string" }, "user": { "type": "string" }, "password": { "type": "string" } } }, "PostgresSourceAuthenticationSecure": { "required": [ "authentication", "description", "id", "organizationalUnitId", "sourceId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "sourceId": { "type": "string", "format": "uuid" }, "authentication": { "$ref": "#/components/schemas/PostgresSourceAuthenticationDetailsSecure" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "KnightVisionSubscriptionRequest": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "WEEKLY", "MONTHLY" ] } } }, "KnightVisionSubscription": { "required": [ "assessmentId", "customerId", "frequency", "userId" ], "type": "object", "properties": { "assessmentId": { "type": "string", "format": "uuid" }, "frequency": { "type": "string", "enum": [ "WEEKLY", "MONTHLY" ] }, "userId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" } } }, "CreateNist80030RiskTemplateRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } } }, "Nist80030RiskTemplate": { "required": [ "createdAt", "createdBy", "customerId", "id", "lastUpdated", "lastUpdatedBy", "name", "nist_800_30RiskTemplateStatusId", "revision" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "riskModelId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "nist_800_30RiskTemplateStatusId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "lastUpdated": { "type": "string", "format": "date-time" } } }, "AssociateControlsNist80030RiskTemplateRequest": { "required": [ "controlIds" ], "type": "object", "properties": { "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "CreateUserRequest": { "required": [ "authenticationMethodId", "email", "firstName", "isGlobalAdmin", "lastName", "organizationalUnitId" ], "type": "object", "properties": { "firstName": { "maxLength": 255, "minLength": 0, "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "lastName": { "maxLength": 255, "minLength": 0, "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "email": { "maxLength": 255, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "authenticationMethodId": { "type": "string", "format": "uuid" }, "isGlobalAdmin": { "type": "boolean" } } }, "AdminUser": { "required": [ "active", "customerId", "email", "enabled", "firstName", "id", "isDeleted", "isGlobalAdmin", "isUsing2FA", "lastName", "revision" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "lastLogin": { "type": "string", "format": "date-time" }, "authenticationGroupId": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" }, "isUsing2FA": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "updatedById": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "verifiedAt": { "type": "string", "format": "date-time" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "authenticationMethodId": { "type": "string", "format": "uuid" }, "isGlobalAdmin": { "type": "boolean" } } }, "ResendEmailResponse": { "required": [ "expiresAt", "status" ], "type": "object", "properties": { "expiresAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "PENDING_VALIDATION", "ENABLED", "DISABLED", "EXPIRED_VALIDATION", "LOCKED", "UNVERIFIED" ] } } }, "ValidateNewUserRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" }, "id": { "type": "string", "format": "uuid" } } }, "ValidationResult": { "required": [ "errors", "isSuccess" ], "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "success": { "type": "boolean", "writeOnly": true } } }, "CreateTagGroupWithTagsRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "AddFrameworkToCustomerRequest": { "required": [ "assessmentWorkflowId", "controlWorkflowId" ], "type": "object", "properties": { "controlWorkflowId": { "type": "string", "format": "uuid" }, "supplementalScoreModelId": { "type": "string", "format": "uuid" }, "assessmentWorkflowId": { "type": "string", "format": "uuid" } } }, "AutomateAssessmentCreationRequestBody": { "required": [ "assessmentName", "organizationalUnitId" ], "type": "object", "properties": { "assessmentName": { "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "AssessmentFrameworkAndControlsDto": { "required": [ "assessment", "frameworkAndControlsDto" ], "type": "object", "properties": { "frameworkAndControlsDto": { "$ref": "#/components/schemas/FrameworkAndControlsDto" }, "assessment": { "$ref": "#/components/schemas/Assessment" } } }, "CreateAssessmentRequest": { "required": [ "assetGroupIds", "frameworkId", "name", "organizationalUnitId" ], "type": "object", "properties": { "name": { "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "frameworkId": { "type": "string", "format": "uuid" }, "level": { "type": "integer", "format": "int32" }, "maturityModel": { "type": "string" }, "ownerId": { "type": "string", "format": "uuid" }, "tags": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "documentStorageLocation": { "maxLength": 255, "minLength": 0, "type": "string" }, "metadataFields": { "type": "object", "additionalProperties": { "type": "string" } }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "assetGroupIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "CreateCrosswalkAssessmentRequest": { "required": [ "fromAssessmentId", "fromFrameworkType", "isSynced", "mappings", "name", "toFrameworkId" ], "type": "object", "properties": { "name": { "type": "string" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkMappingIdentifier" } }, "fromAssessmentId": { "type": "string", "format": "uuid" }, "toFrameworkId": { "type": "string", "format": "uuid" }, "fromFrameworkType": { "type": "string", "enum": [ "Regulatory", "Binary" ] }, "isSynced": { "type": "boolean" }, "levelScore": { "type": "integer", "format": "int32" }, "metadataFields": { "type": "object", "additionalProperties": { "type": "string" } }, "selectedTagIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "CrosswalkMappingIdentifier": { "required": [ "fromFrameworkId", "fromId", "toFrameworkId", "toId" ], "type": "object", "properties": { "fromFrameworkId": { "type": "string", "format": "uuid" }, "fromId": { "type": "string", "format": "uuid" }, "toFrameworkId": { "type": "string", "format": "uuid" }, "toId": { "type": "string", "format": "uuid" } } }, "ValidateAssessmentRequest": { "required": [ "frameworkId", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "frameworkId": { "type": "string", "format": "uuid" }, "level": { "type": "integer", "format": "int32" } } }, "ValidateAssessmentResponse": { "required": [ "errors", "isSuccess" ], "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "errors": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ValidateAssessmentUpdateRequest": { "required": [ "frameworkId" ], "type": "object", "properties": { "frameworkId": { "type": "string", "format": "uuid" }, "level": { "type": "integer", "format": "int32" } } }, "AttackVectorLossCount": { "required": [ "id", "lossFrequency", "lossMagnitude", "name", "nist80053Mappings", "numberOfOccurrences", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "lossMagnitude": { "type": "number" }, "lossFrequency": { "type": "number" }, "numberOfOccurrences": { "type": "number" }, "type": { "type": "string", "enum": [ "FAIR", "NIST", "BAH" ] }, "nist80053Mappings": { "type": "array", "items": { "type": "string" } } } }, "NewIndustryRiskRequestBody": { "required": [ "assessmentId", "attackVectors", "employeeCount", "revenue", "riskRegisterId", "sectorId" ], "type": "object", "properties": { "riskRegisterId": { "type": "string", "format": "uuid" }, "sectorId": { "type": "string", "format": "uuid" }, "advisenSecondaryIndustryId": { "type": "string", "format": "uuid" }, "revenue": { "maximum": 99999999999999, "type": "integer", "format": "int64" }, "employeeCount": { "maximum": 99999999, "type": "integer", "format": "int64" }, "attackVectors": { "type": "array", "items": { "$ref": "#/components/schemas/AttackVectorLossCount" } }, "assessmentId": { "type": "string", "format": "uuid" } } }, "CreateIbmIntegrationAuthenticationRequest": { "required": [ "accountId", "apiKey", "description", "location", "organizationalUnitId" ], "type": "object", "properties": { "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "accountId": { "pattern": "[a-f0-9]{32}", "type": "string" }, "location": { "type": "string" }, "apiKey": { "maxLength": 255, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "CreateGroupRequest": { "required": [ "name", "organizationalUnitId", "roleId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "roleId": { "type": "string", "format": "uuid" } } }, "GroupUserRequest": { "required": [ "operation", "userIds" ], "type": "object", "properties": { "operation": { "pattern": "^(add|remove)$", "type": "string" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "GroupUserResult": { "required": [ "message", "userId" ], "type": "object", "properties": { "message": { "type": "string" }, "userId": { "type": "string", "format": "uuid" } } }, "GroupUserResults": { "required": [ "groupId", "warnings" ], "type": "object", "properties": { "groupId": { "type": "string", "format": "uuid" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/GroupUserResult" } } } }, "CreateGovernanceDashboardRequest": { "required": [ "name", "organizationalUnitId" ], "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "PreviewGovernanceDashboardRequest": { "required": [ "cybersecurityFrameworkId", "dashboardId", "showControlFamily", "showControlFamilyCompare", "showCsfCategory", "showCsfCategoryCompare", "showCsfFunction", "showCsfFunctionCompare" ], "type": "object", "properties": { "showControlFamily": { "type": "boolean" }, "showCsfFunction": { "type": "boolean" }, "showCsfCategory": { "type": "boolean" }, "showCsfFunctionCompare": { "type": "boolean" }, "showCsfCategoryCompare": { "type": "boolean" }, "showControlFamilyCompare": { "type": "boolean" }, "compareDateOne": { "type": "string", "format": "date-time" }, "compareDateTwo": { "type": "string", "format": "date-time" }, "cybersecurityFrameworkId": { "type": "string", "format": "uuid" }, "tags": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "frameworkIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dashboardId": { "type": "string", "format": "uuid" } } }, "ControlFamilyComparisonChart": { "required": [ "meta", "series" ], "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/CsfChartMetadata" }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/SeriesControlFamilyItem" } } } }, "ControlFamilyItem": { "required": [ "name", "score", "targetScore" ], "type": "object", "properties": { "name": { "type": "string" }, "score": { "type": "number" }, "targetScore": { "type": "number" } } }, "ControlFamilyItems": { "required": [ "currentScore", "labels", "targetScore" ], "type": "object", "properties": { "targetScore": { "type": "array", "items": { "type": "number" } }, "currentScore": { "type": "array", "items": { "type": "number" } }, "labels": { "type": "array", "items": { "type": "string" } } } }, "CsfCategoryComparisonChart": { "required": [ "meta", "series" ], "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/CsfChartMetadata" }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/SeriesCsfCategoryItem" } } } }, "CsfCategoryItem": { "required": [ "current", "label", "subcategories", "target" ], "type": "object", "properties": { "label": { "type": "string" }, "uniqueIdentifier": { "type": "string" }, "current": { "type": "number" }, "target": { "type": "number" }, "subcategories": { "type": "array", "items": { "$ref": "#/components/schemas/CsfSubcategoryItem" } }, "targetControlsInCalculation": { "type": "integer", "format": "int32" }, "currentControlsInCalculation": { "type": "integer", "format": "int32" } } }, "CsfCategoryItems": { "required": [ "categories", "meta" ], "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CsfCategoryItem" } }, "meta": { "$ref": "#/components/schemas/CsfChartMetadata" } } }, "CsfChartMetadata": { "required": [ "max", "method", "min", "tick", "weighted" ], "type": "object", "properties": { "min": { "type": "number" }, "max": { "type": "number" }, "tick": { "type": "number" }, "method": { "type": "string", "enum": [ "CYBERSTRONG", "RAW" ] }, "weighted": { "type": "boolean" } } }, "CsfFunctionComparisonChart": { "required": [ "meta", "series" ], "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/CsfChartMetadata" }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/SeriesCsfFunctionItem" } } } }, "CsfFunctionItem": { "required": [ "categories", "current", "label", "target" ], "type": "object", "properties": { "label": { "type": "string" }, "current": { "type": "number" }, "target": { "type": "number" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CsfCategoryItem" } } } }, "CsfFunctionItems": { "required": [ "functions", "meta" ], "type": "object", "properties": { "functions": { "type": "array", "items": { "$ref": "#/components/schemas/CsfFunctionItem" } }, "meta": { "$ref": "#/components/schemas/CsfChartMetadata" } } }, "CsfSubcategoryItem": { "required": [ "current", "label", "target" ], "type": "object", "properties": { "label": { "type": "string" }, "current": { "type": "number" }, "target": { "type": "number" } } }, "GovernanceDashboardPreviewResponse": { "required": [ "max", "min", "tick" ], "type": "object", "properties": { "csfCategoryChart": { "$ref": "#/components/schemas/CsfCategoryItems" }, "csfFunctionChart": { "$ref": "#/components/schemas/CsfFunctionItems" }, "controlFamilyChart": { "$ref": "#/components/schemas/ControlFamilyItems" }, "csfCategoryComparisonChart": { "$ref": "#/components/schemas/CsfCategoryComparisonChart" }, "csfFunctionComparisonChart": { "$ref": "#/components/schemas/CsfFunctionComparisonChart" }, "controlFamilyComparisonChart": { "$ref": "#/components/schemas/ControlFamilyComparisonChart" }, "min": { "type": "number" }, "max": { "type": "number" }, "tick": { "type": "number" } } }, "SeriesControlFamilyItem": { "required": [ "data", "date", "dateFormatted", "label" ], "type": "object", "properties": { "label": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "dateFormatted": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ControlFamilyItem" } } } }, "SeriesCsfCategoryItem": { "required": [ "data", "date", "dateFormatted", "label" ], "type": "object", "properties": { "label": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "dateFormatted": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CsfCategoryItem" } } } }, "SeriesCsfFunctionItem": { "required": [ "data", "date", "dateFormatted", "label" ], "type": "object", "properties": { "label": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "dateFormatted": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CsfFunctionItem" } } } }, "FrameworkRequest": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "CreateFrameworkMetadataField": { "required": [ "label", "required", "type" ], "type": "object", "properties": { "label": { "maxLength": 100, "minLength": 0, "type": "string" }, "hint": { "maxLength": 255, "minLength": 0, "type": "string" }, "type": { "type": "string", "enum": [ "TEXT" ] }, "required": { "type": "boolean" } } }, "FrameworkMetadataField": { "required": [ "createdAt", "createdById", "customerId", "id", "label", "required", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "hint": { "type": "string" }, "type": { "type": "string", "enum": [ "TEXT" ] }, "required": { "type": "boolean" }, "customerId": { "type": "string", "format": "uuid" }, "createdById": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedById": { "type": "string", "format": "uuid" }, "lastUpdatedAt": { "type": "string", "format": "date-time" } } }, "FrameworkSearchRequest": { "required": [ "includeDraft", "selectedIds" ], "type": "object", "properties": { "name": { "type": "string" }, "versions": { "type": "array", "items": { "type": "string" } }, "statuses": { "type": "array", "items": { "type": "string" } }, "selectedIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "onlyShowSelected": { "type": "boolean" }, "includeDraft": { "type": "boolean" } } }, "PageFramework": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/Framework" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "SetFeatureRestrictionRequest": { "required": [ "configFeatureKey", "frameworkId", "restrict", "roleId" ], "type": "object", "properties": { "frameworkId": { "type": "string", "format": "uuid" }, "roleId": { "type": "string", "format": "uuid" }, "configFeatureKey": { "type": "string", "enum": [ "CURRENT_SCORE", "TARGET_SCORE" ] }, "restrict": { "type": "boolean" } } }, "EvaluateFairRiskRequest": { "required": [ "lossFrequencyMaxEvents", "lossFrequencyMaxYears", "lossFrequencyMinEvents", "lossFrequencyMinYears", "lossFrequencyMostLikelyEvents", "lossFrequencyMostLikelyYears", "lossMagnitudeMax", "lossMagnitudeMin", "lossMagnitudeMostLikely", "riskRegisterId" ], "type": "object", "properties": { "lossFrequencyMinEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "lossFrequencyMinYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "lossFrequencyMaxEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "lossFrequencyMaxYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "lossFrequencyMostLikelyEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "lossFrequencyMostLikelyYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "lossFrequencyDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "lossMagnitudeMin": { "type": "integer", "format": "int64" }, "lossMagnitudeMax": { "type": "integer", "format": "int64" }, "lossMagnitudeMostLikely": { "type": "integer", "format": "int64" }, "lossMagnitudeDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "threatFrequencyMinEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatFrequencyMinYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatFrequencyMaxEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatFrequencyMaxYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatFrequencyMostLikelyEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatFrequencyMostLikelyYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "threatFrequencyDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "vulnerabilityMin": { "type": "number" }, "vulnerabilityMax": { "type": "number" }, "vulnerabilityMostLikely": { "type": "number" }, "vulnerabilityDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "contactFrequencyMinEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "contactFrequencyMinYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "contactFrequencyMaxEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "contactFrequencyMaxYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "contactFrequencyMostLikelyEvents": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "contactFrequencyMostLikelyYears": { "maximum": 9999.9, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "contactFrequencyDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "probabilityOfActionMin": { "type": "number" }, "probabilityOfActionMax": { "type": "number" }, "probabilityOfActionMostLikely": { "type": "number" }, "probabilityOfActionDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "threatCapabilityMin": { "type": "number" }, "threatCapabilityMax": { "type": "number" }, "threatCapabilityMostLikely": { "type": "number" }, "threatCapabilityDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "resistanceStrengthMin": { "type": "number" }, "resistanceStrengthMax": { "type": "number" }, "resistanceStrengthMostLikely": { "type": "number" }, "resistanceStrengthDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "primaryLoss": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryLoss" } }, "primaryLossDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "secondaryLefMin": { "type": "number" }, "secondaryLefMax": { "type": "number" }, "secondaryLefMostLikely": { "type": "number" }, "secondaryLefDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "secondaryLm": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryLoss" } }, "secondaryLmDescription": { "maxLength": 1000, "minLength": 0, "type": "string" }, "riskRegisterId": { "type": "string", "format": "uuid" }, "title": { "maxLength": 1000, "minLength": 0, "type": "string" } } }, "FairRiskEvaluation": { "required": [ "createdBy", "effectiveDate", "fairRiskId", "formattedLossMagnitudeMax", "formattedLossMagnitudeMin", "formattedLossMagnitudeMostLikely", "id", "lossCurve", "lossFrequencyMaxEvents", "lossFrequencyMaxYears", "lossFrequencyMinEvents", "lossFrequencyMinYears", "lossFrequencyMostLikelyEvents", "lossFrequencyMostLikelyYears", "lossMagnitudeMax", "lossMagnitudeMin", "lossMagnitudeMostLikely", "maximum", "mean", "minimum", "mostLikely", "ninetyPercentile", "probabilityCurve", "riskDistributionCurve", "simulationHistogram", "stdev", "tenPercentile" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "fairRiskId": { "type": "string", "format": "uuid" }, "lossMagnitudeMin": { "type": "integer", "format": "int64" }, "lossMagnitudeMax": { "type": "integer", "format": "int64" }, "lossMagnitudeMostLikely": { "type": "integer", "format": "int64" }, "lossFrequencyMinEvents": { "type": "number", "format": "double" }, "lossFrequencyMinYears": { "type": "number", "format": "double" }, "lossFrequencyMaxEvents": { "type": "number", "format": "double" }, "lossFrequencyMaxYears": { "type": "number", "format": "double" }, "lossFrequencyMostLikelyEvents": { "type": "number", "format": "double" }, "lossFrequencyMostLikelyYears": { "type": "number", "format": "double" }, "lossCurve": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } }, "probabilityCurve": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } }, "riskDistributionCurve": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } }, "simulationHistogram": { "type": "array", "items": { "type": "number", "format": "double" } }, "stdev": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "mean": { "type": "number" }, "mostLikely": { "type": "number" }, "ninetyPercentile": { "type": "number" }, "tenPercentile": { "type": "number" }, "lossMagnitudeDescription": { "type": "string" }, "lossFrequencyDescription": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "formattedLossMagnitudeMin": { "type": "string" }, "formattedLossMagnitudeMax": { "type": "string" }, "formattedLossMagnitudeMostLikely": { "type": "string" } } }, "CreateExecutiveDashboardDto": { "required": [ "name", "organizationalUnitId" ], "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "ValidateQueryRequest": { "required": [ "query" ], "type": "object", "properties": { "query": { "type": "string" }, "frameworkId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" } } }, "ValidateQueryResponse": { "required": [ "isSuccess" ], "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "error": { "type": "string" } } }, "CreateCustomReportRequest": { "required": [ "name", "organizationalUnitId", "reportTypeId" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string" }, "reportTypeId": { "type": "string", "format": "uuid" }, "reportToClone": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "CrosswalkRequest": { "required": [ "fromFrameworkId", "toFrameworkId" ], "type": "object", "properties": { "fromFrameworkId": { "type": "string", "format": "uuid" }, "toFrameworkId": { "type": "string", "format": "uuid" } } }, "CrosswalkTemplateMapping": { "required": [ "crosswalkTemplateId", "fromId", "isAccepted", "toId" ], "type": "object", "properties": { "crosswalkTemplateId": { "type": "string", "format": "uuid" }, "fromId": { "type": "string", "format": "uuid" }, "toId": { "type": "string", "format": "uuid" }, "isAccepted": { "type": "boolean" } } }, "CrosswalkTemplateRequestBody": { "required": [ "crosswalkTemplateMappings", "fromFrameworkId", "name", "toFrameworkId" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "fromFrameworkId": { "type": "string", "format": "uuid" }, "toFrameworkId": { "type": "string", "format": "uuid" }, "crosswalkTemplateMappings": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkTemplateMapping" } }, "startingTemplateId": { "type": "string", "format": "uuid" } } }, "CrosswalkTemplate": { "required": [ "createdAt", "id", "isPublic", "isPublished", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "createdById": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedById": { "type": "string", "format": "uuid" }, "updatedAt": { "type": "string", "format": "date-time" }, "fromFrameworkId": { "type": "string", "format": "uuid" }, "toFrameworkId": { "type": "string", "format": "uuid" }, "isPublished": { "type": "boolean" }, "startingTemplateId": { "type": "string", "format": "uuid" }, "isPublic": { "type": "boolean" } } }, "CrosswalkTemplateDto": { "required": [ "crosswalkTemplate", "crosswalkTemplateMappings" ], "type": "object", "properties": { "crosswalkTemplate": { "$ref": "#/components/schemas/CrosswalkTemplate" }, "crosswalkTemplateMappings": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkTemplateMapping" } } } }, "ControlScoresForControlsRequest": { "required": [ "controlIds", "controlScoreIds" ], "type": "object", "properties": { "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlScoreIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "validOrganizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskId": { "type": "string", "format": "uuid" }, "riskTemplateId": { "type": "string", "format": "uuid" } } }, "ControlScoresForControlsResponse": { "required": [ "controlScoresWithScores", "controlWithScores" ], "type": "object", "properties": { "controlWithScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWithScores" } }, "controlScoresWithScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWithScoreControlScore" } } } }, "ControlWithScoreControlScore": { "required": [ "assessmentId", "assessmentIdentifier", "assessmentName", "controlFamily", "controlId", "controlLabel", "controlScoreId", "excludeFromScore", "fairCamControlTypes", "frameworkId", "isRestricted", "isScored" ], "type": "object", "properties": { "assessmentName": { "type": "string" }, "score": { "type": "number" }, "normalizedScore": { "type": "number" }, "scoreLabel": { "type": "string" }, "assessmentId": { "type": "string", "format": "uuid" }, "assessmentIdentifier": { "type": "string" }, "controlId": { "type": "string", "format": "uuid" }, "controlScoreId": { "type": "string", "format": "uuid" }, "controlFamily": { "type": "string" }, "controlLabel": { "type": "string" }, "parentControlLabel": { "type": "string" }, "auxiliaryControlLabel": { "type": "string" }, "excludeFromScore": { "type": "boolean" }, "frameworkId": { "type": "string", "format": "uuid" }, "isScored": { "type": "boolean" }, "isRestricted": { "type": "boolean" }, "fairCamControlTypes": { "type": "array", "items": { "type": "string" } }, "detectionWeight": { "type": "number" }, "preventionWeight": { "type": "number" }, "responseWeight": { "type": "number" }, "frameworkNames": { "type": "array", "items": { "type": "string" } }, "assignedTo": { "type": "string", "format": "uuid" }, "assignedUser": { "$ref": "#/components/schemas/BasicUserDto" }, "dueDate": { "type": "string", "format": "date-time" }, "controlWorkflowOptionDefId": { "type": "string", "format": "uuid" }, "controlWorkflowOption": { "$ref": "#/components/schemas/ControlWorkflowOptionEntry" } } }, "ControlWithScores": { "required": [ "controlFamily", "controlId", "controlLabel", "controlScores", "fairCamControlTypes" ], "type": "object", "properties": { "controlId": { "type": "string", "format": "uuid" }, "controlFamily": { "type": "string" }, "controlLabel": { "type": "string" }, "parentControlLabel": { "type": "string" }, "auxiliaryControlLabel": { "type": "string" }, "controlScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWithScoreControlScore" } }, "fairCamControlTypes": { "type": "array", "items": { "type": "string" } }, "detectionWeight": { "type": "number" }, "preventionWeight": { "type": "number" }, "responseWeight": { "type": "number" }, "frameworkNames": { "type": "array", "items": { "type": "string" } }, "score": { "type": "number" }, "normalizedScore": { "type": "number" } } }, "ControlWorkflowOptionEntry": { "required": [ "color", "controlIsDone", "defaultOption", "id", "lastUpdated", "name", "ordinal", "revision" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "tooltip": { "type": "string" }, "color": { "type": "string" }, "controlIsDone": { "type": "boolean" }, "defaultOption": { "type": "boolean" }, "ordinal": { "type": "integer", "format": "int32" }, "revision": { "type": "integer", "format": "int32" }, "lastUpdated": { "type": "string", "format": "date-time" } } }, "ControlQueryParams": { "type": "object", "properties": { "sortKey": { "type": "string" }, "sortValue": { "type": "string" }, "assessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "organizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assignedToIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlFamilies": { "type": "array", "items": { "type": "string" } }, "controlTagIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "csf": { "type": "array", "items": { "type": "string" } }, "maturityScores": { "type": "array", "items": { "type": "number", "format": "double" } }, "searchDescription": { "type": "string" }, "searchName": { "type": "string" }, "userId": { "type": "string", "format": "uuid" }, "workflowStateIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dueDateStart": { "type": "string", "format": "date-time" }, "dueDateEnd": { "type": "string", "format": "date-time" }, "scoreOperator": { "type": "string", "enum": [ "less", "greater", "equal", "no_score" ] }, "types": { "type": "array", "items": { "type": "string", "enum": [ "default", "linked", "disabled", "automated", "recurring" ] } }, "scoreValue": { "type": "number", "format": "float" }, "controlScoreIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlType": { "type": "string" }, "pastDueOnly": { "type": "boolean" } } }, "ControlScoreDetailsAssessmentDto": { "required": [ "id", "name", "organizationalUnitId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "documentStorageLocation": { "type": "string" }, "level": { "type": "integer", "format": "int32" }, "maturityModel": { "type": "string" }, "name": { "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "ControlScoreDetailsDto": { "required": [ "assessment", "control", "controlActionScoreAnnotations", "controlActionScores", "controlActions", "controlScore", "controlSubcategories", "framework", "inherentRisk", "isAutomated", "isCrosswalkSynced", "isReadOnly", "isScored", "residualRisk", "workflowOption" ], "type": "object", "properties": { "controlScore": { "$ref": "#/components/schemas/ControlScore" }, "assessment": { "$ref": "#/components/schemas/ControlScoreDetailsAssessmentDto" }, "assignedTo": { "$ref": "#/components/schemas/AssessmentUserDto" }, "control": { "$ref": "#/components/schemas/Control" }, "controlActions": { "type": "array", "items": { "$ref": "#/components/schemas/ControlAction" } }, "controlActionScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreAction" } }, "controlActionScoreAnnotations": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreActionAnnotation" } }, "controlSubcategories": { "type": "array", "items": { "$ref": "#/components/schemas/CsfSubcategory" } }, "framework": { "$ref": "#/components/schemas/ControlScoreDetailsFrameworkDto" }, "isAutomated": { "type": "boolean" }, "isCrosswalkSynced": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isScored": { "type": "boolean" }, "levelScoringModule": { "$ref": "#/components/schemas/LevelScoringModuleEntry" }, "updatedBy": { "$ref": "#/components/schemas/AssessmentUserDto" }, "workflowOption": { "$ref": "#/components/schemas/ControlWorkflowOptionEntry" }, "readOnly": { "type": "boolean", "writeOnly": true }, "automated": { "type": "boolean", "writeOnly": true }, "crosswalkSynced": { "type": "boolean", "writeOnly": true }, "inherentRisk": { "type": "number" }, "residualRisk": { "type": "number" } } }, "ControlScoreDetailsFrameworkDto": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "Regulatory", "Binary" ] } } }, "LevelScoringModuleEntry": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/LevelScoringValue" } } } }, "LevelScoringValue": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "number", "format": "double" } } }, "PageControlScoreDetailsDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreDetailsDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "ControlScoreDetailsIds": { "required": [ "assessmentId", "controlScoreId" ], "type": "object", "properties": { "controlScoreId": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" } } }, "AnnotationRequestBody": { "required": [ "annotationText" ], "type": "object", "properties": { "annotationText": { "type": "string" } } }, "CreateWorkflowGroupDefinition": { "required": [ "description", "name", "workflowOptions" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "workflowOptions": { "type": "array", "items": { "$ref": "#/components/schemas/CreateWorkflowOptionDefinition" } } } }, "CreateWorkflowOptionDefinition": { "required": [ "color", "controlDoneFlag", "defaultOptionFlag", "name", "ordinal", "roles", "tooltip" ], "type": "object", "properties": { "name": { "type": "string" }, "tooltip": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "color": { "type": "string" }, "controlDoneFlag": { "type": "boolean" }, "defaultOptionFlag": { "type": "boolean" }, "ordinal": { "type": "integer", "format": "int32" } } }, "CreateUpdateAzureIntegrationAuthenticationRequest": { "required": [ "clientId", "clientSecret", "description", "organizationalUnitId", "tenantId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "clientId": { "maxLength": 255, "minLength": 0, "type": "string" }, "clientSecret": { "maxLength": 255, "minLength": 0, "type": "string" }, "tenantId": { "maxLength": 255, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "AzureSourceAuthenticationDetailsSecure": { "required": [ "clientId", "tenantId" ], "type": "object", "properties": { "clientId": { "type": "string" }, "tenantId": { "type": "string" }, "managementGroup": { "type": "string" } } }, "AzureSourceAuthenticationSecure": { "required": [ "authentication", "description", "id", "organizationalUnitId", "sourceId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "sourceId": { "type": "string", "format": "uuid" }, "authentication": { "$ref": "#/components/schemas/AzureSourceAuthenticationDetailsSecure" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "CreateAwsIntegrationAuthenticationRequest": { "required": [ "description", "externalId", "organizationalUnitId", "region", "roleId" ], "type": "object", "properties": { "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "roleId": { "maxLength": 128, "minLength": 0, "type": "string" }, "externalId": { "maxLength": 64, "minLength": 0, "type": "string" }, "region": { "maxLength": 32, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "AuditLogTrackedEventRequest": { "required": [ "description", "entityType", "trackedEventValues" ], "type": "object", "properties": { "description": { "type": "string" }, "entityType": { "type": "string", "enum": [ "ASSESSMENT", "ASSESSOR_MODULE", "ASSESSOR_MODULE_DOCUMENT_REFERENCE", "CMMC_MATURITY_CONTROL_SCORE", "CONTROL_ACTION_SCORE", "CONTROL_ACTION_SCORE_ANNOTATION", "CONTROL_ACTION_SCORE_SUPPLEMENTAL_SCORE", "CONTROL_SCORE", "CONTROL_SCORE_JIRA", "CONTROL_SCORE_REMINDER", "CONTROL_SCORE_REMINDER_USER", "CUSTOMER", "DCMM_MATURITY_CONTROL_SCORE", "EVIDENCE", "NOTES_MODULE", "SIGNOFF_MODULE", "ASSESSMENT_CROSSWALK_START", "ASSESSMENT_CROSSWALK_COMPLETE", "CROSSWALK_TEMPLATE_START", "CROSSWALK_TEMPLATE_PUBLISH", "CROSSWALK_TEMPLATE_APPLY", "CENTRAL_ARTIFACT_LINK" ] }, "trackedEventValues": { "type": "array", "items": { "$ref": "#/components/schemas/TrackedEventValue" } } } }, "TrackedEventValue": { "required": [ "id", "table" ], "type": "object", "properties": { "table": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "extra": { "type": "string" } } }, "AssetGroupAssociationRequest": { "required": [ "ids", "operation" ], "type": "object", "properties": { "operation": { "pattern": "^(add|remove)$", "type": "string" }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "AssetGroupRiskRegisterResult": { "required": [ "message", "riskRegisterId" ], "type": "object", "properties": { "message": { "type": "string" }, "riskRegisterId": { "type": "string", "format": "uuid" } } }, "AssetGroupRiskRegisterResults": { "required": [ "assetGroupId", "warnings" ], "type": "object", "properties": { "assetGroupId": { "type": "string", "format": "uuid" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/AssetGroupRiskRegisterResult" } } } }, "AssetGroupAssessmentResult": { "required": [ "assessmentId", "message" ], "type": "object", "properties": { "message": { "type": "string" }, "assessmentId": { "type": "string", "format": "uuid" } } }, "AssetGroupAssessmentResults": { "required": [ "assetGroupId", "warnings" ], "type": "object", "properties": { "assetGroupId": { "type": "string", "format": "uuid" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/AssetGroupAssessmentResult" } } } }, "CreateAssetAttributeRequest": { "required": [ "name", "type" ], "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "Text", "Numeric", "List" ] }, "listOptions": { "type": "array", "items": { "maxLength": 255, "minLength": 1, "type": "string" } } } }, "AssetAttribute": { "required": [ "createdAt", "customerId", "id", "label", "valueType" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "valueType": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string", "format": "uuid" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "lastUpdatedById": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" } } }, "AssetAttributeAndListOptions": { "required": [ "assetAttribute", "assetAttributeListOptions" ], "type": "object", "properties": { "assetAttribute": { "$ref": "#/components/schemas/AssetAttribute" }, "assetAttributeListOptions": { "type": "array", "items": { "$ref": "#/components/schemas/AssetAttributeListOption" } } } }, "AssetAttributeListOption": { "required": [ "assetAttributeId", "createdAt", "customerId", "id", "sortOrder", "value" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "value": { "type": "string" }, "assetAttributeId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string", "format": "uuid" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "lastUpdatedById": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "sortOrder": { "type": "integer", "format": "int32" } } }, "AssessmentFilters": { "required": [ "active" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "name": { "type": "string" }, "frameworkIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "csfFrameworkIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "active": { "type": "boolean" }, "validOrganizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PageAssessment": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/Assessment" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "ScoreModelValueSetIdsRequest": { "required": [ "controlIds" ], "type": "object", "properties": { "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "ImportAutomationResultsResponse": { "required": [ "isSuccess" ], "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "message": { "type": "string" } } }, "AssessmentConnectorRequest": { "required": [ "connectorIds", "operation" ], "type": "object", "properties": { "operation": { "pattern": "^(add|remove)$", "type": "string" }, "connectorIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "AssessmentConnectorResult": { "required": [ "connectorId", "message" ], "type": "object", "properties": { "message": { "type": "string" }, "connectorId": { "type": "string", "format": "uuid" } } }, "AssessmentConnectorResults": { "required": [ "assessmentId", "warnings" ], "type": "object", "properties": { "assessmentId": { "type": "string", "format": "uuid" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentConnectorResult" } } } }, "CsfScoresRequest": { "type": "object", "properties": { "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "Branch": { "required": [ "mean", "std" ], "type": "object", "properties": { "id": { "type": "string" }, "mean": { "type": "number", "format": "float" }, "std": { "type": "number", "format": "float" } } }, "ControlFamilyRollupDto": { "required": [ "familyLabel", "levels" ], "type": "object", "properties": { "familyLabel": { "type": "string" }, "levels": { "type": "array", "items": { "$ref": "#/components/schemas/ControlFamilyRollupLevel" } } } }, "ControlFamilyRollupLevel": { "required": [ "level", "levelLabel", "scores", "scoresTotal" ], "type": "object", "properties": { "level": { "type": "integer", "format": "int32" }, "levelLabel": { "type": "string" }, "scores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlFamilyRollupScore" } }, "scoresTotal": { "type": "integer", "format": "int32" } } }, "ControlFamilyRollupScore": { "required": [ "count", "order", "scoreLabel" ], "type": "object", "properties": { "scoreLabel": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "order": { "type": "integer", "format": "int32" } } }, "CsfAndControlFamilyChartsForAssessment": { "required": [ "controlFamily", "controlFamilyRollups", "csfCategory", "csfFunction", "industryAverageCategories", "industryAverageFunctions" ], "type": "object", "properties": { "csfCategory": { "$ref": "#/components/schemas/CsfCategoryItems" }, "csfFunction": { "$ref": "#/components/schemas/CsfFunctionItems" }, "industryAverageCategories": { "$ref": "#/components/schemas/IndustryAverageCategories" }, "industryAverageFunctions": { "$ref": "#/components/schemas/IndustryAverageFunctions" }, "controlFamily": { "$ref": "#/components/schemas/CsfChartItem" }, "controlFamilyRollups": { "type": "array", "items": { "$ref": "#/components/schemas/ControlFamilyRollupDto" } } } }, "CsfChartItem": { "required": [ "currentCompliance", "labels", "meta", "targetScore" ], "type": "object", "properties": { "currentCompliance": { "type": "array", "items": { "type": "number" } }, "targetScore": { "type": "array", "items": { "type": "number" } }, "labels": { "type": "array", "items": { "type": "string" } }, "meta": { "$ref": "#/components/schemas/CsfChartMetadata" } } }, "IndustryAverageCategories": { "required": [ "accessControl", "analysis", "anomaliesAndEvents", "assetManagement", "awarenessAndTraining", "businessEnvironment", "continuousMonitoring", "dataSecurity", "detectionProcesses", "governance", "informationProtection", "maintenance", "mitigation", "protectiveTechnology", "recoveryCommunications", "recoveryImprovements", "recoveryPlanning", "responseCommunications", "responseImprovements", "responsePlanning", "riskAssessment", "riskManagement", "supplyChain" ], "type": "object", "properties": { "assetManagement": { "$ref": "#/components/schemas/Branch" }, "businessEnvironment": { "$ref": "#/components/schemas/Branch" }, "governance": { "$ref": "#/components/schemas/Branch" }, "riskAssessment": { "$ref": "#/components/schemas/Branch" }, "riskManagement": { "$ref": "#/components/schemas/Branch" }, "supplyChain": { "$ref": "#/components/schemas/Branch" }, "accessControl": { "$ref": "#/components/schemas/Branch" }, "awarenessAndTraining": { "$ref": "#/components/schemas/Branch" }, "dataSecurity": { "$ref": "#/components/schemas/Branch" }, "informationProtection": { "$ref": "#/components/schemas/Branch" }, "maintenance": { "$ref": "#/components/schemas/Branch" }, "protectiveTechnology": { "$ref": "#/components/schemas/Branch" }, "anomaliesAndEvents": { "$ref": "#/components/schemas/Branch" }, "continuousMonitoring": { "$ref": "#/components/schemas/Branch" }, "detectionProcesses": { "$ref": "#/components/schemas/Branch" }, "responsePlanning": { "$ref": "#/components/schemas/Branch" }, "responseCommunications": { "$ref": "#/components/schemas/Branch" }, "analysis": { "$ref": "#/components/schemas/Branch" }, "mitigation": { "$ref": "#/components/schemas/Branch" }, "responseImprovements": { "$ref": "#/components/schemas/Branch" }, "recoveryPlanning": { "$ref": "#/components/schemas/Branch" }, "recoveryCommunications": { "$ref": "#/components/schemas/Branch" }, "recoveryImprovements": { "$ref": "#/components/schemas/Branch" } } }, "IndustryAverageFunctions": { "required": [ "detect", "identify", "protect", "recover", "respond" ], "type": "object", "properties": { "identify": { "$ref": "#/components/schemas/Branch" }, "protect": { "$ref": "#/components/schemas/Branch" }, "detect": { "$ref": "#/components/schemas/Branch" }, "respond": { "$ref": "#/components/schemas/Branch" }, "recover": { "$ref": "#/components/schemas/Branch" } } }, "CreateJiraTicketRequest": { "type": "object", "properties": { "additionalText": { "type": "string" } } }, "ControlScoreReminderDto": { "required": [ "controlScoreId", "days", "users" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "controlScoreId": { "type": "string", "format": "uuid" }, "days": { "type": "integer", "format": "int32" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" } } } }, "BulkUpdateRequest": { "required": [ "assignedToEnabled", "collaboratorsEnabled", "controlEligibilityEnabled", "controlIds", "currentScoreEnabled", "dueDateEnabled", "dueDateRecurrenceEnabled", "noteEnabled", "reminderEnabled", "targetScoreEnabled", "workflowStateEnabled" ], "type": "object", "properties": { "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assignedTo": { "type": "string", "format": "uuid" }, "dueDate": { "type": "string", "format": "date-time" }, "dueDateRecurrence": { "type": "string", "enum": [ "MONTHLY", "QUARTERLY", "YEARLY" ] }, "addCollaborators": { "type": "string" }, "collaborators": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "reminderDays": { "type": "integer", "format": "int32" }, "reminderUserIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "disabledControls": { "type": "boolean" }, "assignedToEnabled": { "type": "boolean" }, "dueDateEnabled": { "type": "boolean" }, "dueDateRecurrenceEnabled": { "type": "boolean" }, "collaboratorsEnabled": { "type": "boolean" }, "reminderEnabled": { "type": "boolean" }, "controlEligibilityEnabled": { "type": "boolean" }, "workflowStateId": { "type": "string", "format": "uuid" }, "workflowStateEnabled": { "type": "boolean" }, "currentScoreEnabled": { "type": "boolean" }, "targetScoreEnabled": { "type": "boolean" }, "currentScoreId": { "type": "string", "format": "uuid" }, "targetScoreId": { "type": "string", "format": "uuid" }, "setOrClearCurrentScore": { "type": "string" }, "addNote": { "type": "string" }, "note": { "type": "string" }, "noteEnabled": { "type": "boolean" } } }, "SaveAssessmentWorkflowDefinition": { "required": [ "isDefault", "name", "workflowOptions" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "isDefault": { "type": "boolean" }, "workflowOptions": { "type": "array", "items": { "$ref": "#/components/schemas/SaveAssessmentWorkflowOptionDefinition" } } } }, "SaveAssessmentWorkflowOptionDefinition": { "required": [ "idx", "isDone", "isInitial", "name", "roles" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "tooltip": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "isDone": { "type": "boolean" }, "isInitial": { "type": "boolean" }, "idx": { "type": "integer", "format": "int32" } } }, "AzureAutomationTarget": { "type": "object", "properties": { "managementGroupId": { "type": "string" }, "subscriptionId": { "type": "string", "format": "uuid" }, "resourceGroup": { "type": "string" } } }, "SaveAssessmentAutomationDataLakePartRequest": { "required": [ "dataLakeTemplateId", "integrationSourceId" ], "type": "object", "properties": { "integrationSourceId": { "type": "string", "format": "uuid" }, "integrationSourceAuthenticationId": { "type": "string", "format": "uuid" }, "dataLakeTemplateId": { "type": "string", "format": "uuid" }, "params": { "type": "object", "additionalProperties": { "type": "object" } } } }, "SaveAssessmentAutomationPolicyPartRequest": { "required": [ "integrationSourceId", "policyTemplateId" ], "type": "object", "properties": { "integrationSourceId": { "type": "string", "format": "uuid" }, "integrationSourceAuthenticationId": { "type": "string", "format": "uuid" }, "policyTemplateId": { "type": "string", "format": "uuid" }, "azureAutomationTarget": { "$ref": "#/components/schemas/AzureAutomationTarget" }, "params": { "type": "object", "additionalProperties": { "type": "object" } } } }, "SaveAssessmentAutomationRequest": { "required": [ "assessmentId", "connectorIds", "dataLakeParts", "policyParts", "vulnScanParts" ], "type": "object", "properties": { "assessmentId": { "type": "string", "format": "uuid" }, "connectorIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "policyParts": { "type": "array", "items": { "$ref": "#/components/schemas/SaveAssessmentAutomationPolicyPartRequest" } }, "vulnScanParts": { "type": "array", "items": { "$ref": "#/components/schemas/SaveAssessmentAutomationVulnScanPartRequest" } }, "dataLakeParts": { "type": "array", "items": { "$ref": "#/components/schemas/SaveAssessmentAutomationDataLakePartRequest" } } } }, "SaveAssessmentAutomationVulnScanPartRequest": { "required": [ "integrationSourceId", "threshold", "vulnerabilityScanTemplateId" ], "type": "object", "properties": { "integrationSourceId": { "type": "string", "format": "uuid" }, "integrationSourceAuthenticationId": { "type": "string", "format": "uuid" }, "vulnerabilityScanTemplateId": { "type": "string", "format": "uuid" }, "threshold": { "maximum": 365, "minimum": 1, "type": "integer", "format": "int32" }, "params": { "type": "object", "additionalProperties": { "type": "object" } } } }, "CentralArtifact": { "required": [ "createdAt", "createdById", "customerId", "id", "lastUpdatedAt", "lastUpdatedById", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "fileStoreId": { "type": "string", "format": "uuid" }, "evidenceId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "EVIDENCE", "FILE_STORE" ] }, "createdAt": { "type": "string", "format": "date-time" }, "createdById": { "type": "string", "format": "uuid" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "lastUpdatedById": { "type": "string", "format": "uuid" } } }, "CentralArtifactXControlScore": { "required": [ "centralArtifactId", "controlScoreId", "lastLinkedBy", "lastLinkedOn" ], "type": "object", "properties": { "centralArtifactId": { "type": "string", "format": "uuid" }, "controlScoreId": { "type": "string", "format": "uuid" }, "lastLinkedOn": { "type": "string", "format": "date-time" }, "lastLinkedBy": { "type": "string", "format": "uuid" } } }, "GenerateApiKeyResponse": { "required": [ "apiKey", "apiKeySecretStr", "createdAt", "id" ], "type": "object", "properties": { "apiKey": { "type": "string" }, "apiKeySecretStr": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" } } }, "SummaryRequest": { "required": [ "customerId", "userId" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" } } }, "ProvisionInstanceRequest": { "required": [ "customerName", "selectedPackage", "userEmail", "userFirstName", "userLastName" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "customerName": { "maxLength": 100, "minLength": 2, "type": "string" }, "userId": { "type": "string", "format": "uuid" }, "userFirstName": { "maxLength": 255, "minLength": 0, "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "userLastName": { "maxLength": 255, "minLength": 0, "pattern": "[\\d\\D]*[^\\s]+[\\d\\D]*", "type": "string" }, "userEmail": { "maxLength": 255, "minLength": 0, "type": "string" }, "selectedPackage": { "pattern": "^(Trial|Compliance|Risk|Executive)$", "type": "string" }, "selectedAddOns": { "type": "array", "items": { "type": "string" } } } }, "CreateVulnerabilityScanTemplateRequest": { "required": [ "entries", "frameworkId", "name", "sourceId" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string" }, "frameworkId": { "type": "string", "format": "uuid" }, "sourceId": { "type": "string", "format": "uuid" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/VulnerabilityScanTemplateEntry" } } } }, "VulnerabilityScanTemplateEntry": { "required": [ "controlActionId", "controlId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "templateId": { "type": "string", "format": "uuid" }, "controlId": { "type": "string", "format": "uuid" }, "controlActionId": { "type": "string", "format": "uuid" } } }, "ScheduledJobResult": { "required": [ "jobStatus" ], "type": "object", "properties": { "jobStatus": { "type": "string", "enum": [ "RUNNING", "SUCCESS", "FAILURE", "FINISHED_EARLY" ] }, "details": { "type": "string" } } }, "InformationalControlsOptionDto": { "required": [ "label", "ordinal" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "informationalControlsOptionSetId": { "type": "string", "format": "uuid" }, "label": { "maxLength": 255, "minLength": 0, "type": "string" }, "ordinal": { "type": "integer", "format": "int32" } } }, "InformationalControlsOptionSetDto": { "required": [ "name", "options" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "customerName": { "type": "string" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/InformationalControlsOptionDto" } } } }, "InformationalControlsControlDto": { "required": [ "label", "questionSets" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "customerName": { "type": "string" }, "label": { "maxLength": 255, "minLength": 0, "type": "string" }, "questionSets": { "type": "array", "items": { "$ref": "#/components/schemas/InformationalControlsQuestionSetDto" } } } }, "InformationalControlsQuestionSetDto": { "required": [ "informationalControlsOptionSetId", "ordinal", "question" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "informationalControlsControlId": { "type": "string", "format": "uuid" }, "question": { "type": "string" }, "informationalControlsOptionSetId": { "type": "string", "format": "uuid" }, "ordinal": { "type": "integer", "format": "int32" } } }, "CreateFrameworkRequest": { "required": [ "assessmentCharts", "assessmentScoreMethod", "controlScoreMethod", "csfWeighted", "customScoreModel", "cybersecurityFrameworkId", "name", "type", "version" ], "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "controlWorkflowGroupId": { "type": "string", "format": "uuid" }, "assessmentWorkflowGroupId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "Regulatory", "Binary" ] }, "assessmentScoreMethod": { "type": "string", "enum": [ "DFARS_171A", "RAW_CONTROL_FAMILY", "RAW_LEVELED_CONTROL_FAMILY", "RAW_PARENT_CONTROL_LABEL", "RAW", "CONTROL_FAMILY", "PARENT_CONTROL_LABEL", "CYBERSTRONG", "CMMC_2" ] }, "customScoreModel": { "type": "string", "format": "uuid" }, "controlScoreMethod": { "type": "string", "enum": [ "BINARY", "LEVEL", "REGULATORY", "CMMC_2" ] }, "userId": { "type": "string", "format": "uuid" }, "parentId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "modules": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "levelModel": { "type": "string", "format": "uuid" }, "cybersecurityFrameworkId": { "type": "string", "format": "uuid" }, "csfWeighted": { "type": "boolean" }, "supplementalScoreModelId": { "type": "string", "format": "uuid" }, "assessmentCharts": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "CreateCustomerRequest": { "required": [ "blacklistEmails", "name", "prefix", "urlToken" ], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 2, "type": "string" }, "urlToken": { "maxLength": 100, "minLength": 1, "pattern": "([a-z_0-9\\-]+)?", "type": "string" }, "prefix": { "maxLength": 3, "minLength": 3, "pattern": "([A-Z0-9]+)?", "type": "string" }, "blacklistEmails": { "type": "boolean" }, "selectedPackageId": { "type": "string", "format": "uuid" }, "selectedFeatures": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "CreateCrosswalkMappingsResponse": { "required": [ "alertType", "mappings", "message", "status" ], "type": "object", "properties": { "status": { "type": "string", "enum": [ "100 CONTINUE", "101 SWITCHING_PROTOCOLS", "102 PROCESSING", "103 EARLY_HINTS", "103 CHECKPOINT", "200 OK", "201 CREATED", "202 ACCEPTED", "203 NON_AUTHORITATIVE_INFORMATION", "204 NO_CONTENT", "205 RESET_CONTENT", "206 PARTIAL_CONTENT", "207 MULTI_STATUS", "208 ALREADY_REPORTED", "226 IM_USED", "300 MULTIPLE_CHOICES", "301 MOVED_PERMANENTLY", "302 FOUND", "302 MOVED_TEMPORARILY", "303 SEE_OTHER", "304 NOT_MODIFIED", "305 USE_PROXY", "307 TEMPORARY_REDIRECT", "308 PERMANENT_REDIRECT", "400 BAD_REQUEST", "401 UNAUTHORIZED", "402 PAYMENT_REQUIRED", "403 FORBIDDEN", "404 NOT_FOUND", "405 METHOD_NOT_ALLOWED", "406 NOT_ACCEPTABLE", "407 PROXY_AUTHENTICATION_REQUIRED", "408 REQUEST_TIMEOUT", "409 CONFLICT", "410 GONE", "411 LENGTH_REQUIRED", "412 PRECONDITION_FAILED", "413 PAYLOAD_TOO_LARGE", "413 REQUEST_ENTITY_TOO_LARGE", "414 URI_TOO_LONG", "414 REQUEST_URI_TOO_LONG", "415 UNSUPPORTED_MEDIA_TYPE", "416 REQUESTED_RANGE_NOT_SATISFIABLE", "417 EXPECTATION_FAILED", "418 I_AM_A_TEAPOT", "419 INSUFFICIENT_SPACE_ON_RESOURCE", "420 METHOD_FAILURE", "421 DESTINATION_LOCKED", "422 UNPROCESSABLE_ENTITY", "423 LOCKED", "424 FAILED_DEPENDENCY", "425 TOO_EARLY", "426 UPGRADE_REQUIRED", "428 PRECONDITION_REQUIRED", "429 TOO_MANY_REQUESTS", "431 REQUEST_HEADER_FIELDS_TOO_LARGE", "451 UNAVAILABLE_FOR_LEGAL_REASONS", "500 INTERNAL_SERVER_ERROR", "501 NOT_IMPLEMENTED", "502 BAD_GATEWAY", "503 SERVICE_UNAVAILABLE", "504 GATEWAY_TIMEOUT", "505 HTTP_VERSION_NOT_SUPPORTED", "506 VARIANT_ALSO_NEGOTIATES", "507 INSUFFICIENT_STORAGE", "508 LOOP_DETECTED", "509 BANDWIDTH_LIMIT_EXCEEDED", "510 NOT_EXTENDED", "511 NETWORK_AUTHENTICATION_REQUIRED" ] }, "message": { "type": "string" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/UUIDsMapping" } }, "alertType": { "type": "string", "enum": [ "SUCCESS", "INFO", "WARNING" ] } } }, "UUIDsMapping": { "required": [ "fromFrameworkId", "fromId", "toFrameworkId", "toId" ], "type": "object", "properties": { "fromFrameworkId": { "type": "string", "format": "uuid" }, "fromId": { "type": "string", "format": "uuid" }, "toFrameworkId": { "type": "string", "format": "uuid" }, "toId": { "type": "string", "format": "uuid" }, "confidence": { "type": "number" } } }, "ControlActionScoreGuidanceUpdateRequest": { "required": [ "customerId", "frameworkId" ], "type": "object", "properties": { "frameworkId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "scoreGuidanceSetId": { "type": "string", "format": "uuid" } } }, "CreateControlCatalogRequest": { "required": [ "name", "version" ], "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "description": { "type": "string" } } }, "VerifyUserRequest": { "required": [ "confirmPassword", "password", "token" ], "type": "object", "properties": { "confirmPassword": { "type": "string" }, "password": { "maxLength": 64, "minLength": 8, "type": "string" }, "token": { "type": "string" } } }, "UpdateTenableIntegrationAuthenticationRequest": { "required": [ "accessKey", "description", "id", "organizationalUnitId", "secretKey", "url" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "url": { "maxLength": 255, "minLength": 0, "type": "string" }, "accessKey": { "maxLength": 64, "minLength": 0, "type": "string" }, "secretKey": { "maxLength": 64, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "EnableMultiFactorRequest": { "required": [ "id", "totp" ], "type": "object", "properties": { "totp": { "type": "string" }, "id": { "type": "string", "format": "uuid" } } }, "PasswordResetRequest": { "required": [ "confirmPassword", "currentPassword", "password" ], "type": "object", "properties": { "currentPassword": { "type": "string" }, "password": { "maxLength": 64, "minLength": 8, "type": "string" }, "confirmPassword": { "type": "string" } } }, "UserDto2": { "required": [ "createdAt", "displayName", "email", "enabled", "firstName", "id", "isGlobalAdmin", "isUsing2FA", "lastName" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "enabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "isUsing2FA": { "type": "boolean" }, "displayName": { "type": "string" }, "isGlobalAdmin": { "type": "boolean" } } }, "RiskPatch": { "type": "object", "properties": { "isIndustryRiskSynced": { "type": "boolean" } } }, "PatchRiskModelRequest": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "boolean" } } }, "UpdateQualysIntegrationAuthenticationRequest": { "required": [ "description", "id", "organizationalUnitId", "password", "url", "username" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "url": { "maxLength": 64, "minLength": 0, "type": "string" }, "username": { "maxLength": 64, "minLength": 0, "type": "string" }, "password": { "maxLength": 64, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "UpdatePostgresIntegrationAuthenticationRequest": { "required": [ "database", "description", "host", "id", "organizationalUnitId", "password", "port", "user" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "host": { "maxLength": 255, "minLength": 0, "type": "string" }, "database": { "maxLength": 255, "minLength": 0, "type": "string" }, "port": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32" }, "user": { "maxLength": 255, "minLength": 0, "type": "string" }, "password": { "maxLength": 64, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "UpdateNist80030RiskTemplateRequest": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "riskModelId": { "type": "string", "format": "uuid" }, "nist80030RiskTemplateStatusId": { "type": "string", "format": "uuid" } } }, "UpdateRiskTemplateDataRequest": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "riskNistTypeId": { "type": "string", "format": "uuid" }, "externalId": { "type": "string" }, "riskNistCategoryId": { "type": "string", "format": "uuid" }, "clearCategoryId": { "type": "boolean" }, "riskTreatmentPlanSelectedOption": { "type": "string", "format": "uuid" }, "dueDate": { "type": "string", "format": "date-time" }, "clearDueDate": { "type": "boolean" }, "note": { "type": "string" }, "ownerIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "RiskTemplateData": { "required": [ "createdAt", "createdBy", "customerId", "id", "lastUpdated", "lastUpdatedBy", "nist_800_30RiskTemplateId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nist_800_30RiskTemplateId": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "riskMethod": { "type": "string" }, "externalId": { "type": "string" }, "categoryId": { "type": "string", "format": "uuid" }, "riskTreatmentPlanSelectedOption": { "type": "string", "format": "uuid" }, "dueDate": { "type": "string", "format": "date-time" }, "note": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "lastUpdated": { "type": "string", "format": "date-time" }, "riskNistCategoryId": { "type": "string", "format": "uuid" }, "riskNistTypeId": { "type": "string", "format": "uuid" } } }, "UpdateNist80030RiskTemplateDataRequest": { "type": "object", "properties": { "likelihoodId": { "type": "string", "format": "uuid" }, "likelihoodDetails": { "type": "string" }, "impactId": { "type": "string", "format": "uuid" }, "impactDetails": { "type": "string" }, "singleLossExpectancyMin": { "maximum": 999999999999999, "minimum": 0, "type": "integer", "format": "int64" }, "singleLossExpectancyMax": { "maximum": 999999999999999, "minimum": 0, "type": "integer", "format": "int64" }, "singleLossExpectancyMostLikely": { "maximum": 999999999999999, "minimum": 0, "type": "integer", "format": "int64" }, "trend": { "type": "string" }, "threatEventFrequencyMinEvents": { "type": "number" }, "threatEventFrequencyMinYears": { "type": "number" }, "threatEventFrequencyMaxEvents": { "type": "number" }, "threatEventFrequencyMaxYears": { "type": "number" }, "threatEventFrequencyMostLikelyEvents": { "type": "number" }, "threatEventFrequencyMostLikelyYears": { "type": "number" }, "targetEnabled": { "type": "boolean" }, "targetLikelihoodId": { "type": "string", "format": "uuid" }, "targetDate": { "type": "string", "format": "date-time" }, "clearTargetDate": { "type": "boolean" }, "targetSingleLossExpectancyEnabled": { "type": "boolean" }, "targetThreatEventFrequencyMinEvents": { "type": "number" }, "targetThreatEventFrequencyMinYears": { "type": "number" }, "targetThreatEventFrequencyMaxEvents": { "type": "number" }, "targetThreatEventFrequencyMaxYears": { "type": "number" }, "targetThreatEventFrequencyMostLikelyEvents": { "type": "number" }, "targetThreatEventFrequencyMostLikelyYears": { "type": "number" }, "targetSingleLossExpectancyMin": { "type": "integer", "format": "int64" }, "targetSingleLossExpectancyMax": { "type": "integer", "format": "int64" }, "targetSingleLossExpectancyMostLikely": { "type": "integer", "format": "int64" } } }, "Nist80030RiskTemplateData": { "required": [ "id", "nist_800_30RiskTemplateId", "revision", "riskTemplateDataId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "format": "int32" }, "nist_800_30RiskTemplateId": { "type": "string", "format": "uuid" }, "riskTemplateDataId": { "type": "string", "format": "uuid" }, "likelihoodId": { "type": "string", "format": "uuid" }, "likelihoodDetails": { "type": "string" }, "impactId": { "type": "string", "format": "uuid" }, "impactDetails": { "type": "string" }, "singleLossExpectancyMin": { "type": "integer", "format": "int64" }, "singleLossExpectancyMax": { "type": "integer", "format": "int64" }, "singleLossExpectancyMostLikely": { "type": "integer", "format": "int64" }, "trend": { "type": "string" }, "threatEventFrequencyMinEvents": { "type": "number" }, "threatEventFrequencyMinYears": { "type": "number" }, "threatEventFrequencyMaxEvents": { "type": "number" }, "threatEventFrequencyMaxYears": { "type": "number" }, "threatEventFrequencyMostLikelyEvents": { "type": "number" }, "threatEventFrequencyMostLikelyYears": { "type": "number" }, "targetEnabled": { "type": "boolean" }, "targetLikelihoodId": { "type": "string", "format": "uuid" }, "targetDate": { "type": "string", "format": "date-time" }, "targetSingleLossExpectancyEnabled": { "type": "boolean" }, "targetThreatEventFrequencyMinEvents": { "type": "number" }, "targetThreatEventFrequencyMinYears": { "type": "number" }, "targetThreatEventFrequencyMaxEvents": { "type": "number" }, "targetThreatEventFrequencyMaxYears": { "type": "number" }, "targetThreatEventFrequencyMostLikelyEvents": { "type": "number" }, "targetThreatEventFrequencyMostLikelyYears": { "type": "number" }, "targetSingleLossExpectancyMin": { "type": "integer", "format": "int64" }, "targetSingleLossExpectancyMax": { "type": "integer", "format": "int64" }, "targetSingleLossExpectancyMostLikely": { "type": "integer", "format": "int64" }, "singleLossExpectancyMinFormatted": { "type": "string" }, "singleLossExpectancyMaxFormatted": { "type": "string" }, "singleLossExpectancyMostLikelyFormatted": { "type": "string" }, "targetSingleLossExpectancyMinFormatted": { "type": "string" }, "targetSingleLossExpectancyMaxFormatted": { "type": "string" }, "targetSingleLossExpectancyMostLikelyFormatted": { "type": "string" } } }, "ChangePasswordRequest": { "required": [ "confirmPassword", "password" ], "type": "object", "properties": { "password": { "maxLength": 64, "minLength": 8, "type": "string" }, "confirmPassword": { "type": "string" } } }, "UserVerification": { "required": [ "createdAt", "expiresAt", "id", "token", "userId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "token": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "verifiedAt": { "type": "string", "format": "date-time" } } }, "EditCustomReportRequest": { "required": [ "id", "name", "organizationalUnitId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "UpdateCustomReportFieldsRequest": { "required": [ "fieldIds" ], "type": "object", "properties": { "fieldIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "ToggleFavoriteRequest": { "required": [ "isFavorite" ], "type": "object", "properties": { "isFavorite": { "type": "boolean" } } }, "CrosswalkTemplatePatchRequestBody": { "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "description": { "maxLength": 255, "minLength": 0, "type": "string" }, "fromId": { "type": "string", "format": "uuid" }, "toId": { "type": "string", "format": "uuid" }, "isAccepted": { "type": "boolean" }, "isPublished": { "type": "boolean" } } }, "CrosswalkHistoryPatch": { "type": "object", "properties": { "isSynced": { "type": "boolean" } } }, "CrosswalkHistory": { "required": [ "fromAssessmentId", "fromControlScoreId", "fromFrameworkId", "fromId", "id", "isSynced", "toAssessmentId", "toControlScoreId", "toFrameworkId", "toId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fromAssessmentId": { "type": "string", "format": "uuid" }, "toAssessmentId": { "type": "string", "format": "uuid" }, "fromFrameworkId": { "type": "string", "format": "uuid" }, "fromId": { "type": "string", "format": "uuid" }, "toFrameworkId": { "type": "string", "format": "uuid" }, "toId": { "type": "string", "format": "uuid" }, "isSynced": { "type": "boolean" }, "fromControlScoreId": { "type": "string", "format": "uuid" }, "toControlScoreId": { "type": "string", "format": "uuid" }, "fromControlActionScoreId": { "type": "string", "format": "uuid" }, "toControlActionScoreId": { "type": "string", "format": "uuid" } } }, "ControlActionPatchRequest": { "required": [ "path" ], "type": "object", "properties": { "path": { "type": "string" }, "value": { "type": "object" } } }, "ControlScorePatchRequest": { "required": [ "controlId", "controlScoreId", "path" ], "type": "object", "properties": { "op": { "type": "string" }, "path": { "type": "string" }, "value": { "type": "object" }, "controlId": { "type": "string", "format": "uuid" }, "controlScoreId": { "type": "string", "format": "uuid" } } }, "ModulePatchRequest": { "required": [ "controlScoreId", "path" ], "type": "object", "properties": { "path": { "type": "string" }, "value": { "type": "object" }, "controlScoreId": { "type": "string", "format": "uuid" } } }, "CentralArtifactPatch": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } } }, "ArtifactAndLinksDto": { "required": [ "centralArtifact", "links" ], "type": "object", "properties": { "centralArtifact": { "$ref": "#/components/schemas/CentralArtifact" }, "evidence": { "$ref": "#/components/schemas/Evidence" }, "fileStore": { "$ref": "#/components/schemas/FileStoreExternal" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentControlScoreAndControl" } } } }, "AssessmentControlScoreAndControl": { "required": [ "assessment", "control", "controlScore" ], "type": "object", "properties": { "controlScore": { "$ref": "#/components/schemas/ControlScore" }, "control": { "$ref": "#/components/schemas/Control" }, "assessment": { "$ref": "#/components/schemas/Assessment" } } }, "Evidence": { "required": [ "active", "id", "location", "name", "revision" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "format": "int32" }, "customerId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "location": { "type": "string" } } }, "FileStoreExternal": { "required": [ "customerId", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "contentType": { "type": "string" } } }, "CreateEnvironmentSettingsRequestBody": { "type": "object", "properties": { "customName": { "maxLength": 10, "minLength": 0, "type": "string" } } }, "EnvironmentSettings": { "required": [ "lastUpdatedAt", "lastUpdatedBy" ], "type": "object", "properties": { "customName": { "maxLength": 10, "minLength": 0, "type": "string" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" } } }, "JsonMergePatch": { "type": "object" }, "AssessmentReportResponse": { "required": [ "createdBy", "id", "lastUpdatedBy", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "createdBy": { "$ref": "#/components/schemas/PrincipalDto" }, "lastUpdatedBy": { "$ref": "#/components/schemas/PrincipalDto" } } }, "VulnerabilityScanTemplate": { "required": [ "frameworkId", "lastUpdated", "name", "sourceId", "updatedBy" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "frameworkId": { "type": "string", "format": "uuid" }, "frameworkName": { "type": "string" }, "updatedBy": { "type": "string", "format": "uuid" }, "lastUpdated": { "type": "string", "format": "date-time" }, "sourceId": { "type": "string", "format": "uuid" }, "sourceName": { "type": "string" } } }, "VulnerabilityScanTemplateEntrySummary": { "required": [ "controlFamilyName", "controlName", "key" ], "type": "object", "properties": { "key": { "type": "string" }, "controlName": { "type": "string" }, "controlFamilyName": { "type": "string" }, "controlActionContent": { "type": "string" } } }, "AdminUserDto": { "required": [ "accountIsLocked", "authenticationMethod", "createdAt", "email", "enabled", "firstName", "id", "isGlobalAdmin", "isUsing2FA", "lastName", "status" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "enabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "isUsing2FA": { "type": "boolean" }, "status": { "type": "string", "enum": [ "PENDING_VALIDATION", "ENABLED", "DISABLED", "EXPIRED_VALIDATION", "LOCKED", "UNVERIFIED" ] }, "lastLogin": { "type": "string", "format": "date-time" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "totalControlScoresCount": { "type": "integer", "format": "int32" }, "completedControlScoresCount": { "type": "integer", "format": "int32" }, "overDueControlScoresCount": { "type": "integer", "format": "int32" }, "collaboratingOnControlCount": { "type": "integer", "format": "int32" }, "accountIsLocked": { "type": "boolean" }, "authenticationMethod": { "type": "string", "enum": [ "SAML", "OIDC", "PASSWORD" ] }, "authenticationGroupId": { "type": "string", "format": "uuid" }, "authenticationMethodId": { "type": "string", "format": "uuid" }, "isGlobalAdmin": { "type": "boolean" } } }, "PageAdminUserDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AdminUserDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "PageRiskOwnerRiskDashboardDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/RiskOwnerRiskDashboardDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "RiskOwnerRiskDashboardDto": { "required": [ "riskDashboardId", "riskDashboardName", "riskId", "riskMethod", "riskName", "riskOwners" ], "type": "object", "properties": { "riskId": { "type": "string", "format": "uuid" }, "riskOwners": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" } }, "riskName": { "type": "string" }, "riskMethod": { "type": "string" }, "riskTreatmentPlanSelectedOptionId": { "type": "string", "format": "uuid" }, "riskTreatmentPlanSelectedOptionName": { "type": "string" }, "riskDashboardId": { "type": "string", "format": "uuid" }, "riskDashboardName": { "type": "string" } } }, "Option": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "OwnedRisksConfig": { "required": [ "dashboardOptions", "riskTypeOptions", "treatmentPlanOptions" ], "type": "object", "properties": { "dashboardOptions": { "type": "array", "items": { "$ref": "#/components/schemas/Option" } }, "riskTypeOptions": { "type": "array", "items": { "type": "string" } }, "treatmentPlanOptions": { "type": "array", "items": { "$ref": "#/components/schemas/Option" } } } }, "ScoreModelReturnData": { "required": [ "id", "name", "values" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreModelReturnDataValue" } } } }, "ScoreModelReturnDataValue": { "required": [ "id", "label", "order", "value" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "supplementalScoreModelId": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "number", "format": "double" }, "order": { "type": "integer", "format": "int32" } } }, "ScoreModelValueSetDto": { "required": [ "id", "label", "scoreModelId", "values" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "scoreModelId": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreModelValue" } } } }, "ScoreGuidance": { "required": [ "guidanceText", "id", "title" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "guidanceText": { "type": "string" } } }, "PageRole": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "Permission": { "required": [ "group", "id", "name", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "group": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "VIEW", "EDIT", "CREATE", "DELETE" ] } } }, "RiskSummaryFilterParams": { "required": [ "categoryIds", "hasRiskCategory", "riskMethodId" ], "type": "object", "properties": { "riskNameSearch": { "type": "string" }, "riskMethodId": { "type": "string", "format": "uuid" }, "riskDashboardNames": { "type": "array", "items": { "type": "string" } }, "executiveDashboardId": { "type": "string", "format": "uuid" }, "hasRiskCategory": { "type": "boolean" }, "categoryIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskRegisterIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "validOrganizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskNistTypeId": { "type": "string", "format": "uuid" }, "riskNistCategoryId": { "type": "string", "format": "uuid" } } }, "DashboardConfigurationRiskSummary": { "required": [ "canBeIndustryRiskSynced", "id", "isIndustryRiskSynced", "name", "riskDashboardName", "riskMethod", "riskNistTypeId", "riskNistTypeName" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "canBeIndustryRiskSynced": { "type": "boolean" }, "isIndustryRiskSynced": { "type": "boolean" }, "name": { "type": "string" }, "riskMethod": { "type": "string", "enum": [ "FAIR", "NIST", "BAH" ] }, "overallResidualRiskLevelValue": { "type": "number" }, "targetOverallResidualRiskLevelValue": { "type": "number" }, "ttpThreatCoverageValue": { "type": "number" }, "annualizedLossExpectancy": { "type": "number" }, "riskNistTypeId": { "type": "string", "format": "uuid" }, "riskNistTypeName": { "type": "string" }, "riskNistCategoryId": { "type": "string", "format": "uuid" }, "riskNistCategoryName": { "type": "string" }, "riskDashboardName": { "type": "string" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } } } }, "PageDashboardConfigurationRiskSummary": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardConfigurationRiskSummary" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "PageRiskSummaryDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/RiskSummaryDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "RiskSummaryDto": { "required": [ "id", "method", "name", "owners", "registerId", "registerName", "typeName" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "method": { "type": "string", "enum": [ "FAIR", "NIST", "BAH" ] }, "registerId": { "type": "string", "format": "uuid" }, "categoryName": { "type": "string" }, "registerName": { "type": "string" }, "residualRisk": { "type": "number" }, "inherentRisk": { "type": "number" }, "treatmentPlanId": { "type": "string", "format": "uuid" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" } }, "typeName": { "type": "string" } } }, "RiskAleOverTime": { "required": [ "inherent", "residual" ], "type": "object", "properties": { "inherent": { "type": "array", "items": { "$ref": "#/components/schemas/RiskAleStat" } }, "residual": { "type": "array", "items": { "$ref": "#/components/schemas/RiskAleStat" } } } }, "RiskAleStat": { "required": [ "ale", "time" ], "type": "object", "properties": { "time": { "type": "integer", "format": "int64" }, "ale": { "type": "number" } } }, "OverallRiskStat": { "required": [ "inheritRisk", "residualRisk", "time" ], "type": "object", "properties": { "time": { "type": "integer", "format": "int64" }, "inheritRisk": { "type": "number" }, "residualRisk": { "type": "number" } } }, "RiskControlStat": { "required": [ "entries", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/RiskControlStatEntry" } } } }, "RiskControlStatEntry": { "required": [ "time" ], "type": "object", "properties": { "time": { "type": "integer", "format": "int64" }, "score": { "type": "number" } } }, "RiskSummary": { "required": [ "canBeIndustryRiskSynced", "createdAt", "createdBy", "id", "isIndustryRiskSynced", "lastUpdated", "lastUpdatedBy", "name", "owners", "revision", "riskMethod", "riskNistTypeId", "riskNistTypeName", "riskRegisterId", "riskTreatmentPlanId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "$ref": "#/components/schemas/UserDto" }, "lastUpdated": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "$ref": "#/components/schemas/UserDto" }, "riskRegisterId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "riskNistTypeId": { "type": "string", "format": "uuid" }, "riskNistTypeName": { "type": "string" }, "riskNistCategoryId": { "type": "string", "format": "uuid" }, "riskNistCategoryName": { "type": "string" }, "description": { "type": "string" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" } }, "riskMethod": { "type": "string", "enum": [ "FAIR", "NIST", "BAH" ] }, "controlScoreAvg": { "type": "number" }, "trend": { "type": "string", "enum": [ "UP", "NO_CHANGE", "DOWN" ] }, "trendLabel": { "type": "string" }, "levelOfRiskValue": { "type": "integer", "format": "int32" }, "levelOfRiskLabel": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "COMPLETED", "FAILED", "RECALCULATING" ] }, "overallResidualRiskLevelValue": { "type": "number" }, "targetOverallResidualRiskLevelValue": { "type": "number" }, "ttpCoverageValue": { "type": "number" }, "avgLossExposure": { "type": "number" }, "riskTreatmentPlanId": { "type": "string", "format": "uuid" }, "annualizedLossExpectancyMin": { "type": "integer", "format": "int64" }, "annualizedLossExpectancyMax": { "type": "integer", "format": "int64" }, "annualizedLossExpectancyMostLikely": { "type": "integer", "format": "int64" }, "canBeIndustryRiskSynced": { "type": "boolean" }, "isIndustryRiskSynced": { "type": "boolean" }, "inherentRisk": { "type": "number" }, "residualRisk": { "type": "number" }, "weightedAvgScore": { "type": "number" }, "weightedNormalizedAvgScore": { "type": "number" } } }, "RiskTreatmentPlanOption": { "required": [ "id", "idx", "title" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "idx": { "type": "integer", "format": "int32" }, "title": { "type": "string" } } }, "RiskLevelFilters": { "required": [ "impactId", "likelihoodId" ], "type": "object", "properties": { "impactId": { "type": "string", "format": "uuid" }, "likelihoodId": { "type": "string", "format": "uuid" } } }, "RiskModelLegendValue": { "required": [ "color", "id", "label", "riskModelId", "seq" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "riskModelId": { "type": "string", "format": "uuid" }, "seq": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "color": { "type": "string" } } }, "AssessmentIdentification": { "required": [ "id", "identifier", "identifierNumber", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "identifier": { "type": "string" }, "identifierNumber": { "type": "integer", "format": "int32" }, "name": { "type": "string" } } }, "RiskAssociationConfig": { "required": [ "riskAssessmentNames" ], "type": "object", "properties": { "riskAssessmentNames": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentIdentification" } } } }, "RiskRemediationProjectDashboardFilters": { "type": "object", "properties": { "riskId": { "type": "string", "format": "uuid" }, "riskDashboardId": { "type": "string", "format": "uuid" } } }, "RiskRemediationProjectAndDashboard": { "required": [ "dashboard", "project" ], "type": "object", "properties": { "project": { "$ref": "#/components/schemas/RiskRemediationProject" }, "dashboard": { "$ref": "#/components/schemas/RiskRemediationDashboard" } } }, "RiskRemediationProjectAndDashboardSummary": { "required": [ "hasAccessToAllDashboards", "projectDashboards" ], "type": "object", "properties": { "projectDashboards": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRemediationProjectAndDashboard" } }, "hasAccessToAllDashboards": { "type": "boolean" } } }, "RiskFilterParams": { "type": "object", "properties": { "name": { "type": "string" }, "riskNistTypeId": { "type": "string", "format": "uuid" }, "riskNistCategoryId": { "type": "string", "format": "uuid" }, "levels": { "type": "array", "items": { "type": "string" } }, "owners": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskRegisterIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "RiskOverviewStats": { "required": [ "overallInherentRisk", "overallResidualRisk" ], "type": "object", "properties": { "avgOverallRiskScore": { "type": "number" }, "avgControlScore": { "type": "number" }, "overallInherentRisk": { "type": "number" }, "overallResidualRisk": { "type": "number" } } }, "RiskImpactSummary": { "required": [ "impactLabel", "impactValue", "likelihoodLabel", "likelihoodValue", "maxSingleLossExpectancy", "maxThreatEventFrequency", "minSingleLossExpectancy", "minThreatEventFrequency", "mostLikelySingleLossExpectancy", "mostLikelyThreatEventFrequency", "name", "riskId", "riskOverall" ], "type": "object", "properties": { "impactValue": { "type": "number" }, "likelihoodValue": { "type": "number" }, "minThreatEventFrequency": { "type": "number" }, "maxThreatEventFrequency": { "type": "number" }, "mostLikelyThreatEventFrequency": { "type": "number" }, "minSingleLossExpectancy": { "type": "integer", "format": "int64" }, "maxSingleLossExpectancy": { "type": "integer", "format": "int64" }, "mostLikelySingleLossExpectancy": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "impactLabel": { "type": "string" }, "riskOverall": { "type": "string" }, "likelihoodLabel": { "type": "string" }, "riskId": { "type": "string", "format": "uuid" } } }, "ExecutiveDashboardRiskSummary": { "required": [ "annualizedLossExpectancy", "id", "name", "riskMethod" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "levelOfRiskLabel": { "type": "string" }, "levelOfRiskValue": { "type": "integer", "format": "int32" }, "riskMethod": { "type": "string", "enum": [ "FAIR", "NIST", "BAH" ] }, "overallResidualRiskLevelValue": { "type": "number" }, "targetOverallResidualRiskLevelValue": { "type": "number" }, "avgLossExposure": { "type": "number" }, "annualizedLossExpectancy": { "type": "integer", "format": "int64" } } }, "BahRiskDto": { "required": [ "annualizedLossExpectancyMax", "annualizedLossExpectancyMin", "annualizedLossExpectancyMostLikely", "id", "lastUpdated", "name", "owners", "riskNistTypeId", "riskRegisterId", "status" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "riskNistTypeId": { "type": "string", "format": "uuid" }, "riskNistCategoryId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" } }, "status": { "type": "string" }, "riskRegisterId": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" }, "treatmentPlanOptionId": { "type": "string", "format": "uuid" }, "treatmentPlanDueDate": { "type": "string", "format": "date-time" }, "treatmentPlanNote": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "overallInherentLikelihoodLevelValue": { "type": "number" }, "overallInherentLikelihoodLevelVariance": { "type": "number" }, "overallInherentLikelihoodLevelConfidence": { "type": "number" }, "overallResidualLikelihoodLevelValue": { "type": "number" }, "overallResidualLikelihoodLevelVariance": { "type": "number" }, "overallResidualLikelihoodLevelConfidence": { "type": "number" }, "overallInherentImpactLevelValue": { "type": "number" }, "overallInherentImpactLevelVariance": { "type": "number" }, "overallInherentImpactLevelConfidence": { "type": "number" }, "overallResidualImpactLevelValue": { "type": "number" }, "overallResidualImpactLevelVariance": { "type": "number" }, "overallResidualImpactLevelConfidence": { "type": "number" }, "overallInherentRiskLevelValue": { "type": "number" }, "overallInherentRiskLevelVariance": { "type": "number" }, "overallInherentRiskLevelConfidence": { "type": "number" }, "overallResidualRiskLevelValue": { "type": "number" }, "overallResidualRiskLevelVariance": { "type": "number" }, "overallResidualRiskLevelConfidence": { "type": "number" }, "attackSurface": { "type": "number" }, "threatActorCapacity": { "type": "number" }, "threatLevel": { "type": "number" }, "priorAttackProbability": { "type": "number" }, "attackProbability": { "type": "number" }, "attackMotivators": { "type": "number" }, "exploitability": { "type": "number" }, "vulnerability": { "type": "number" }, "directImpact": { "type": "number" }, "indirectImpact": { "type": "number" }, "targetOverallInherentLikelihoodLevelValue": { "type": "number" }, "targetOverallInherentLikelihoodLevelVariance": { "type": "number" }, "targetOverallInherentLikelihoodLevelConfidence": { "type": "number" }, "targetOverallResidualLikelihoodLevelValue": { "type": "number" }, "targetOverallResidualLikelihoodLevelVariance": { "type": "number" }, "targetOverallResidualLikelihoodLevelConfidence": { "type": "number" }, "targetOverallInherentImpactLevelValue": { "type": "number" }, "targetOverallInherentImpactLevelVariance": { "type": "number" }, "targetOverallInherentImpactLevelConfidence": { "type": "number" }, "targetOverallResidualImpactLevelValue": { "type": "number" }, "targetOverallResidualImpactLevelVariance": { "type": "number" }, "targetOverallResidualImpactLevelConfidence": { "type": "number" }, "targetOverallInherentRiskLevelValue": { "type": "number" }, "targetOverallInherentRiskLevelVariance": { "type": "number" }, "targetOverallInherentRiskLevelConfidence": { "type": "number" }, "targetOverallResidualRiskLevelValue": { "type": "number" }, "targetOverallResidualRiskLevelVariance": { "type": "number" }, "targetOverallResidualRiskLevelConfidence": { "type": "number" }, "targetAttackSurface": { "type": "number" }, "targetThreatActorCapacity": { "type": "number" }, "targetThreatLevel": { "type": "number" }, "targetPriorAttackProbability": { "type": "number" }, "targetAttackProbability": { "type": "number" }, "targetAttackMotivators": { "type": "number" }, "targetExploitability": { "type": "number" }, "targetVulnerability": { "type": "number" }, "targetDirectImpact": { "type": "number" }, "targetIndirectImpact": { "type": "number" }, "ttpThreatCoverageValue": { "type": "number" }, "ttpThreatCoverageVariance": { "type": "number" }, "ttpThreatCoverageConfidence": { "type": "number" }, "ttpControlCoverageValue": { "type": "number" }, "ttpControlCoverageVariance": { "type": "number" }, "ttpControlCoverageConfidence": { "type": "number" }, "ttpControlEffectivenessValue": { "type": "number" }, "ttpControlEffectivenessVariance": { "type": "number" }, "ttpControlEffectivenessConfidence": { "type": "number" }, "annualizedLossExpectancyMin": { "type": "integer", "format": "int64" }, "annualizedLossExpectancyMax": { "type": "integer", "format": "int64" }, "annualizedLossExpectancyMostLikely": { "type": "integer", "format": "int64" } } }, "ControlIdAndCsfFunctionName": { "required": [ "controlId" ], "type": "object", "properties": { "controlId": { "type": "string", "format": "uuid" }, "csfFunctionName": { "type": "string" } } }, "BahOptionSetPopulated": { "required": [ "categoryId", "id", "question", "subcategoryId", "title" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "question": { "type": "string" }, "subcategoryId": { "type": "string", "format": "uuid" }, "categoryId": { "type": "string", "format": "uuid" } } }, "BahRiskScorePopulated": { "required": [ "option", "optionSet" ], "type": "object", "properties": { "optionSet": { "$ref": "#/components/schemas/BahOptionSetPopulated" }, "option": { "$ref": "#/components/schemas/BahOption" }, "note": { "type": "string" } } }, "BahCategory": { "required": [ "id", "idx", "subcategories", "title" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "subcategories": { "type": "array", "items": { "$ref": "#/components/schemas/BahSubcategory" } }, "idx": { "type": "integer", "format": "int32" } } }, "BahSubcategory": { "required": [ "id", "optionSets", "title" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "optionSets": { "type": "array", "items": { "$ref": "#/components/schemas/BahOptionSet" } } } }, "RiskTreatmentPlanHistoryDto": { "required": [ "createdAt", "id", "lastUpdated", "lastUpdatedBy", "operation", "revision", "riskId", "riskTreatmentPlanSelectedOption" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "format": "int32" }, "riskId": { "type": "string", "format": "uuid" }, "riskTreatmentPlanSelectedOption": { "$ref": "#/components/schemas/RiskTreatmentPlanOption" }, "dueDate": { "type": "string", "format": "date-time" }, "note": { "type": "string" }, "lastUpdatedBy": { "$ref": "#/components/schemas/BasicUserDto" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "operation": { "type": "string" } } }, "RiskRemediationProjectFilters": { "type": "object", "properties": { "name": { "type": "string" }, "priority": { "type": "string", "format": "uuid" }, "status": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskRemediationDashboardIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "validOrganizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PageImplRiskRemediationProject": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRemediationProject" } }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "last": { "type": "boolean" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "RiskRemediationProjectSummaryFiltersParams": { "type": "object", "properties": { "statusFilter": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskRemediationDashboardIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "validOrganizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PageRiskRemediationProjectSummary": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRemediationProjectSummary" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "RiskRemediationProjectSummary": { "required": [ "csfControlProgress", "durationMonths", "durationYears", "id", "laborCostMedian", "name", "oneTimeCostMedian", "overallInherentRisk", "overallResidualRisk", "projectCost", "projectType", "recurringCostMedian", "relatedRiskNumber", "riskRemediationDashboardId", "startDate" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "priority": { "type": "string" }, "projectType": { "type": "string" }, "relatedRiskNumber": { "type": "integer", "format": "int32" }, "projectCost": { "type": "number", "format": "double" }, "durationYears": { "type": "integer", "format": "int32" }, "durationMonths": { "type": "integer", "format": "int32" }, "csfControlProgress": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "rosi": { "type": "integer", "format": "int32" }, "riskReduction": { "type": "number", "format": "double" }, "annualizedLossExpectancy": { "type": "number", "format": "double" }, "oneTimeCostMedian": { "type": "number" }, "laborCostMedian": { "type": "number" }, "recurringCostMedian": { "type": "number" }, "riskReductionPercentage": { "type": "number", "format": "double" }, "riskRemediationDashboardId": { "type": "string", "format": "uuid" }, "overallInherentRisk": { "type": "number", "format": "double" }, "overallResidualRisk": { "type": "number", "format": "double" } } }, "RiskRemediation": { "required": [ "dashboardId", "dashboardMethodId", "dashboardMethodName", "dashboardName", "id", "isIndustryRiskSynced", "name", "organizationalUnitId", "treatmentPlanId", "treatmentPlanName" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "isIndustryRiskSynced": { "type": "boolean" }, "dashboardId": { "type": "string", "format": "uuid" }, "dashboardName": { "type": "string" }, "dashboardMethodId": { "type": "string", "format": "uuid" }, "dashboardMethodName": { "type": "string" }, "treatmentPlanId": { "type": "string", "format": "uuid" }, "treatmentPlanName": { "type": "string" }, "annualizedLossExpectancy": { "type": "number" }, "hasControls": { "type": "boolean" }, "hasGlobalControls": { "type": "boolean" }, "level": { "type": "string" }, "assessmentId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "ControlScoreActionTargetSummary": { "required": [ "controlScore", "targetScoreValueId" ], "type": "object", "properties": { "controlScoreAction": { "$ref": "#/components/schemas/ControlScoreAction" }, "controlScore": { "$ref": "#/components/schemas/ControlScore" }, "targetScoreValueId": { "type": "string", "format": "uuid" }, "targetScoreNumericValue": { "type": "number", "format": "double" } } }, "RiskRemediationProjectOption": { "required": [ "id", "idx", "title" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "idx": { "type": "integer", "format": "int32" } } }, "RiskRemediationAllRisksFilters": { "type": "object", "properties": { "riskName": { "type": "string" }, "riskRegisterIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskDashboardMethodId": { "type": "string", "format": "uuid" }, "riskTreatmentPlan": { "type": "string", "format": "uuid" }, "riskRemediationDashboardId": { "type": "string", "format": "uuid" }, "organizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PageRiskRemediation": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRemediation" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "RosiComparisonParameters": { "required": [ "riskRemediationDashboardId" ], "type": "object", "properties": { "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskRemediationDashboardId": { "type": "string", "format": "uuid" } } }, "PageRiskScenarioSummary": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/RiskScenarioSummary" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "RiskScenarioSummary": { "required": [ "associatedProjects", "id", "method", "name", "treatmentPlanSelectedOptionLabel" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "method": { "type": "string" }, "riskLevelLabel": { "type": "string" }, "treatmentPlanSelectedOptionLabel": { "type": "string" }, "associatedProjects": { "type": "string" }, "annualizedLossExpectancy": { "type": "number", "format": "double" } } }, "PageRiskAssociatedAssessmentControlScore": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/RiskAssociatedAssessmentControlScore" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "RiskAssociatedAssessmentControlScore": { "required": [ "control", "isGlobalControl" ], "type": "object", "properties": { "isGlobalControl": { "type": "boolean" }, "control": { "$ref": "#/components/schemas/Control" }, "frameworks": { "type": "array", "items": { "$ref": "#/components/schemas/Framework" } }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/Assessment" } }, "controlScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScore" } }, "averageScore": { "type": "number", "format": "float" }, "averageNormalizedScore": { "type": "integer", "format": "int32" }, "isRestricted": { "type": "boolean" }, "isAssessmentRestricted": { "type": "boolean" }, "hasNoControlAccess": { "type": "boolean" } } }, "RemediationTimelineParams": { "type": "object", "properties": { "riskRemediationDashboardId": { "type": "string", "format": "uuid" }, "riskRemediationProjectStatusIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "ProjectTimelineEntry": { "required": [ "durationInMonths", "id", "name", "projectCost", "startDate" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "durationInMonths": { "type": "integer", "format": "int32" }, "projectCost": { "type": "number", "format": "double" } } }, "ProjectTimelineDefaultDateRange": { "required": [ "endDate", "startDate" ], "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } } }, "RiskRemediationDashboardReductionSummary": { "type": "object", "properties": { "totalRiskReduction": { "type": "number", "format": "double" }, "totalAnnualizedLossExpectancy": { "type": "number", "format": "double" } } }, "RiskRemediationProjectDashboardSummary": { "type": "object", "properties": { "totalRiskReduction": { "type": "number", "format": "double" }, "totalRosi": { "type": "number", "format": "double" }, "totalAnnualizedLossExpectancy": { "type": "number", "format": "double" }, "totalProjectCost": { "type": "number", "format": "double" }, "totalAnnualizedProjectCost": { "type": "number", "format": "double" } } }, "RiskRemediationDashboardCostSummary": { "type": "object", "properties": { "totalAnnualizedProjectCost": { "type": "number", "format": "double" }, "totalProjectCost": { "type": "number", "format": "double" } } }, "CsfSubcategoryCategoryFunction": { "required": [ "categoryId", "categoryName", "categoryUniqueIdentifier", "functionId", "functionName", "functionUniqueIdentifier", "subcategoryDescription", "subcategoryId" ], "type": "object", "properties": { "subcategoryId": { "type": "string" }, "subcategoryDescription": { "type": "string" }, "categoryId": { "type": "string", "format": "uuid" }, "categoryName": { "type": "string" }, "categoryUniqueIdentifier": { "type": "string" }, "functionId": { "type": "string", "format": "uuid" }, "functionName": { "type": "string" }, "functionUniqueIdentifier": { "type": "string" } } }, "RemediationDashboardFilterParams": { "type": "object", "properties": { "remediationDashboardName": { "type": "string" }, "riskRemediationDashboardIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskRemediationProjectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "organizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PageImplRiskRemediationDashboard": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRemediationDashboard" } }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "last": { "type": "boolean" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "RiskRemediationDashboardSummary": { "required": [ "riskRemediationDashboard" ], "type": "object", "properties": { "riskRemediationDashboard": { "$ref": "#/components/schemas/RiskRemediationDashboard" }, "totalProjectCount": { "type": "integer", "format": "int32" }, "annualizedRiskReduction": { "type": "number", "format": "double" }, "totalRiskReduction": { "type": "number", "format": "double" }, "annualizedProjectCost": { "type": "number", "format": "double" }, "totalProjectCost": { "type": "number", "format": "double" }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRemediationProject" } } } }, "RemediationDashboardSummaryFilters": { "type": "object", "properties": { "dashboardName": { "type": "string" }, "projectName": { "type": "string" }, "projectPriority": { "type": "string", "format": "uuid" }, "projectStatus": { "type": "string", "format": "uuid" }, "organizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PageRiskRemediationDashboardSummary": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRemediationDashboardSummary" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "RiskRegisterFilters": { "type": "object", "properties": { "riskDashboardName": { "type": "string" }, "riskScenarioName": { "type": "string" }, "riskMethod": { "type": "array", "items": { "type": "string" } }, "riskTreatmentPlan": { "type": "string", "format": "uuid" }, "organizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assessmentId": { "type": "string", "format": "uuid" }, "riskRegisterIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PageImplRiskRegisterAndRiskInfoDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRegisterAndRiskInfoDto" } }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "last": { "type": "boolean" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "RiskRegisterAndRiskInfoDto": { "required": [ "customerId", "id", "name", "organizationalUnitId", "riskRegisterMethodId", "riskRegisterMethodTitle", "risksCount" ], "type": "object", "properties": { "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "id": { "type": "string", "format": "uuid" }, "riskRegisterMethodId": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" }, "riskRegisterMethodTitle": { "type": "string" }, "risksCount": { "type": "integer", "format": "int32" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "RiskRegisterConfig": { "required": [ "assignableUsers", "projectAssignableUsers" ], "type": "object", "properties": { "assignableUsers": { "type": "array", "items": { "$ref": "#/components/schemas/AdminUser" } }, "projectAssignableUsers": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } } } }, "BahRiskSummary": { "required": [ "risks" ], "type": "object", "properties": { "current": { "type": "number" }, "currentNormalized": { "type": "number" }, "target": { "type": "number" }, "targetNormalized": { "type": "number" }, "risks": { "type": "array", "items": { "$ref": "#/components/schemas/BahRiskDto" } } } }, "RiskRegisterSectorsAndPresetsDto": { "required": [ "riskRegisterXAdvisenSectors", "riskRegisterXRiskPresets" ], "type": "object", "properties": { "riskRegisterXAdvisenSectors": { "$ref": "#/components/schemas/RiskRegisterXAdvisenSectors" }, "riskRegisterXRiskPresets": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRegisterXRiskPreset" } } } }, "RiskRegisterXRiskPreset": { "required": [ "createdAt", "createdBy", "riskId", "riskPresetId", "riskRegisterId" ], "type": "object", "properties": { "riskRegisterId": { "type": "string", "format": "uuid" }, "riskPresetId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "uuid" }, "riskId": { "type": "string", "format": "uuid" } } }, "RiskRegisterType": { "required": [ "id", "title" ], "type": "object", "properties": { "title": { "type": "string" }, "id": { "type": "string", "format": "uuid" } } }, "RiskRegisterSummaryFilters": { "type": "object", "properties": { "riskDashboardName": { "type": "string" }, "riskScenarioName": { "type": "string" }, "riskMethod": { "type": "string" }, "riskTreatmentPlan": { "type": "string", "format": "uuid" }, "organizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assessmentId": { "type": "string", "format": "uuid" }, "riskRegisterIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PageRiskRegisterSummary": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRegisterSummary" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "RiskRegisterSummary": { "required": [ "riskRegisterDto", "riskRegisterMethodTitle", "riskSummaries", "totalRiskCount" ], "type": "object", "properties": { "riskRegisterDto": { "$ref": "#/components/schemas/RiskRegisterDto" }, "riskRegisterMethodTitle": { "type": "string" }, "totalRiskCount": { "type": "integer", "format": "int32" }, "riskSummaries": { "type": "array", "items": { "$ref": "#/components/schemas/RiskSummary" } } } }, "RiskRegistersConfig": { "required": [ "riskRegisterDtos", "riskRegisterMethods", "riskTreatmentPlanOptions" ], "type": "object", "properties": { "riskRegisterDtos": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRegisterDto" } }, "riskRegisterMethods": { "type": "array", "items": { "$ref": "#/components/schemas/RiskRegisterType" } }, "riskTreatmentPlanOptions": { "type": "array", "items": { "$ref": "#/components/schemas/RiskTreatmentPlanOption" } } } }, "RiskNistTypeFilters": { "type": "object", "properties": { "riskTypeName": { "type": "string" }, "riskCategoryName": { "type": "string" }, "riskRegisterIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PageImplRiskNistTypeSummary": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/RiskNistTypeSummary" } }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "last": { "type": "boolean" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "RiskModelSummaryDto": { "required": [ "customerId", "enabled", "id", "impactCount", "likelihoodCount", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "impactCount": { "type": "integer", "format": "int32" }, "likelihoodCount": { "type": "integer", "format": "int32" }, "customerId": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" } } }, "Report": { "required": [ "id", "reportNodes", "title", "type", "value" ], "type": "object", "properties": { "title": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "integer", "format": "int32" }, "reportNodes": { "type": "array", "items": { "$ref": "#/components/schemas/ReportNode" } }, "id": { "type": "string", "format": "uuid" } } }, "ReportNode": { "required": [ "controlIds", "label", "values" ], "type": "object", "properties": { "idx": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/ReportResult" } } } }, "ReportResult": { "required": [ "label", "values" ], "type": "object", "properties": { "idx": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "values": { "type": "array", "items": { "type": "number" } } } }, "CsfAndControlFamilyChartsForCustomer": { "required": [ "controlFamily", "csfFrameworks", "industryAverageCategories", "industryAverageFunctions" ], "type": "object", "properties": { "csfFrameworks": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CsfFrameworkEntry" } }, "controlFamily": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CsfChartItem" } }, "industryAverageFunctions": { "$ref": "#/components/schemas/IndustryAverageFunctions" }, "industryAverageCategories": { "$ref": "#/components/schemas/IndustryAverageCategories" } } }, "CsfFrameworkEntry": { "required": [ "categories", "functions", "meta" ], "type": "object", "properties": { "functions": { "type": "array", "items": { "$ref": "#/components/schemas/CsfFunctionItem" } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CsfCategoryItem" } }, "meta": { "$ref": "#/components/schemas/CsfChartMetadata" } } }, "QualitativePresetOption": { "required": [ "id", "max", "min", "mostLikely", "optionType", "order", "presetType", "subtitle", "title" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "presetType": { "type": "string", "enum": [ "IMPACT", "LIKELIHOOD" ] }, "optionType": { "type": "string", "enum": [ "VERY_LOW", "LOW", "LOW_AS_FIRST", "LOW_AS_NEXT", "MODERATE", "HIGH", "HIGH_AS_NEXT", "HIGH_AS_LAST", "VERY_HIGH_AS_NEXT", "VERY_HIGH_AS_LAST", "SEVERE", "CERTAIN" ] }, "order": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "min": { "type": "number" }, "max": { "type": "number" }, "mostLikely": { "type": "number" } } }, "QualitativePresetOptions": { "required": [ "count", "impactOptions", "likelihoodOptions" ], "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "impactOptions": { "type": "array", "items": { "$ref": "#/components/schemas/QualitativePresetOption" } }, "likelihoodOptions": { "type": "array", "items": { "$ref": "#/components/schemas/QualitativePresetOption" } } } }, "PostHogConfigResponse": { "type": "object", "properties": { "key": { "type": "string" } } }, "PagePolicyTemplate": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyTemplate" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "PolicyTemplate": { "required": [ "frameworkId", "id", "lastUpdated", "name", "sourceId", "updatedBy" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "frameworkId": { "type": "string", "format": "uuid" }, "frameworkName": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "customerName": { "type": "string" }, "updatedBy": { "type": "string", "format": "uuid" }, "lastUpdated": { "type": "string", "format": "date-time" }, "sourceId": { "type": "string", "format": "uuid" }, "sourceName": { "type": "string" } } }, "ControlToPoliciesSummary": { "required": [ "controlFamilyName", "controlName", "policyList" ], "type": "object", "properties": { "controlName": { "type": "string" }, "controlFamilyName": { "type": "string" }, "controlActionContent": { "type": "string" }, "policyList": { "type": "array", "items": { "$ref": "#/components/schemas/PolicySummary" } } } }, "PolicySummary": { "required": [ "identifierName" ], "type": "object", "properties": { "identifierName": { "type": "string" }, "identifierDescription": { "type": "string" } } }, "PermissionDetails": { "required": [ "organizationalUnitIds", "permission" ], "type": "object", "properties": { "permission": { "$ref": "#/components/schemas/Permission" }, "organizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PermissionSummary": { "required": [ "customerId", "permissionDetails", "userId" ], "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "permissionDetails": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionDetails" } } } }, "PermissionGroup": { "required": [ "name", "permissionNames" ], "type": "object", "properties": { "name": { "type": "string" }, "permissionNames": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionName" } } } }, "PermissionName": { "required": [ "name", "permissionParts" ], "type": "object", "properties": { "name": { "type": "string" }, "permissionParts": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionPart" } } } }, "PermissionPart": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "VIEW", "EDIT", "CREATE", "DELETE" ] } } }, "OrganizationalUnitContentSummary": { "required": [ "assessmentCount", "assetGroupCount", "authenticationMethodCount", "customReportCount", "descendantsHaveContent", "executiveDashboardCount", "governanceDashboardCount", "groupCount", "integrationSourceAuthenticationCount", "organizationalUnit", "riskRegisterCount", "riskRemediationDashboardCount", "roleCount", "userCount" ], "type": "object", "properties": { "organizationalUnit": { "$ref": "#/components/schemas/OrganizationalUnit" }, "descendantsHaveContent": { "type": "boolean" }, "assessmentCount": { "type": "integer", "format": "int32" }, "assetGroupCount": { "type": "integer", "format": "int32" }, "authenticationMethodCount": { "type": "integer", "format": "int32" }, "customReportCount": { "type": "integer", "format": "int32" }, "executiveDashboardCount": { "type": "integer", "format": "int32" }, "governanceDashboardCount": { "type": "integer", "format": "int32" }, "groupCount": { "type": "integer", "format": "int32" }, "integrationSourceAuthenticationCount": { "type": "integer", "format": "int32" }, "riskRegisterCount": { "type": "integer", "format": "int32" }, "riskRemediationDashboardCount": { "type": "integer", "format": "int32" }, "roleCount": { "type": "integer", "format": "int32" }, "userCount": { "type": "integer", "format": "int32" } } }, "OrganizationalUnitTreeNode": { "required": [ "children", "organizationalUnit" ], "type": "object", "properties": { "organizationalUnit": { "$ref": "#/components/schemas/OrganizationalUnit" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationalUnitTreeNode" } } } }, "KnightVisionAssessmentSubscriptionResponse": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "WEEKLY", "MONTHLY" ] } } }, "Nist80030RiskTarget": { "required": [ "id", "singleLossExpectancyEnabled", "threatEventFrequencyMaxEvents", "threatEventFrequencyMaxYears", "threatEventFrequencyMinEvents", "threatEventFrequencyMinYears", "threatEventFrequencyMostLikelyEvents", "threatEventFrequencyMostLikelyYears" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "singleLossExpectancyEnabled": { "type": "boolean" }, "likelihoodId": { "type": "string", "format": "uuid" }, "singleLossExpectancyMin": { "type": "integer", "format": "int64" }, "singleLossExpectancyMax": { "type": "integer", "format": "int64" }, "singleLossExpectancyMostLikely": { "type": "integer", "format": "int64" }, "targetDate": { "type": "string", "format": "date-time" }, "threatEventFrequencyMinEvents": { "type": "number" }, "threatEventFrequencyMinYears": { "type": "number" }, "threatEventFrequencyMaxEvents": { "type": "number" }, "threatEventFrequencyMaxYears": { "type": "number" }, "threatEventFrequencyMostLikelyEvents": { "type": "number" }, "threatEventFrequencyMostLikelyYears": { "type": "number" }, "singleLossExpectancyMinFormatted": { "type": "string" }, "singleLossExpectancyMaxFormatted": { "type": "string" }, "singleLossExpectancyMostLikelyFormatted": { "type": "string" } } }, "RiskModel": { "required": [ "customerId", "enabled", "id", "impactCount", "likelihoodCount", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "impactCount": { "type": "integer", "format": "int32" }, "likelihoodCount": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" } } }, "RiskNist80030Dto": { "required": [ "nist80030Risk", "owners", "risk", "riskModel", "treatmentPlan" ], "type": "object", "properties": { "risk": { "$ref": "#/components/schemas/Risk" }, "nist80030Risk": { "$ref": "#/components/schemas/Nist80030RiskEntity" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } }, "riskModel": { "$ref": "#/components/schemas/RiskModel" }, "nist80030Target": { "$ref": "#/components/schemas/Nist80030RiskTarget" }, "treatmentPlan": { "$ref": "#/components/schemas/RiskTreatmentPlan" } } }, "RiskTreatmentPlan": { "required": [ "createdAt", "createdBy", "customerId", "id", "lastUpdated", "lastUpdatedBy", "revision", "riskId", "riskTreatmentPlanSelectedOption" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "revision": { "type": "integer", "format": "int32" }, "riskId": { "type": "string", "format": "uuid" }, "riskTreatmentPlanSelectedOption": { "type": "string", "format": "uuid" }, "dueDate": { "type": "string", "format": "date-time" }, "note": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "lastUpdated": { "type": "string", "format": "date-time" } } }, "RiskModelValue": { "required": [ "id", "label", "riskModelId", "seq", "value" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "value": { "type": "number" }, "seq": { "type": "integer", "format": "int32" }, "riskModelId": { "type": "string", "format": "uuid" } } }, "RiskNist80030ExtraDataDto": { "required": [ "impactValue", "inherentRisk", "likelihoodValue", "modelLegendValue", "nist80030Risk", "owners", "risk", "riskModel", "treatmentPlan" ], "type": "object", "properties": { "risk": { "$ref": "#/components/schemas/Risk" }, "nist80030Risk": { "$ref": "#/components/schemas/Nist80030RiskEntity" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } }, "riskModel": { "$ref": "#/components/schemas/RiskModel" }, "nist80030Target": { "$ref": "#/components/schemas/Nist80030RiskTarget" }, "treatmentPlan": { "$ref": "#/components/schemas/RiskTreatmentPlan" }, "likelihoodValue": { "$ref": "#/components/schemas/RiskModelValue" }, "modelLegendValue": { "$ref": "#/components/schemas/RiskModelLegendValue" }, "targetLikelihoodValue": { "$ref": "#/components/schemas/RiskModelValue" }, "impactValue": { "$ref": "#/components/schemas/RiskModelValue" }, "residualRisk": { "type": "integer", "format": "int64" }, "inherentRisk": { "type": "integer", "format": "int64" } } }, "RiskNist80030ControlAndScores": { "required": [ "associatedControlScores", "associatedControls" ], "type": "object", "properties": { "associatedControls": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWithScores" } }, "associatedControlScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWithScoreControlScore" } } } }, "Nist80030RiskTemplateFilters": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string", "format": "uuid" }, "riskModel": { "type": "string", "format": "uuid" }, "assessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "Nist80030RiskTemplateControlsCount": { "required": [ "associatedControlsCount", "nist80030RiskTemplate" ], "type": "object", "properties": { "nist80030RiskTemplate": { "$ref": "#/components/schemas/Nist80030RiskTemplate" }, "associatedControlsCount": { "type": "integer", "format": "int32" } } }, "PageImplNist80030RiskTemplateControlsCount": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/Nist80030RiskTemplateControlsCount" } }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "last": { "type": "boolean" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "Nist80030RiskTemplateSummary": { "required": [ "associatedControls", "nist80030RiskTemplate", "nist80030RiskTemplateData", "owners", "riskTemplateData" ], "type": "object", "properties": { "nist80030RiskTemplate": { "$ref": "#/components/schemas/Nist80030RiskTemplate" }, "riskTemplateData": { "$ref": "#/components/schemas/RiskTemplateData" }, "nist80030RiskTemplateData": { "$ref": "#/components/schemas/Nist80030RiskTemplateData" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } }, "riskModelLegendValue": { "$ref": "#/components/schemas/RiskModelLegendValue" }, "associatedControls": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWithScores" } } } }, "Nist80030RiskTemplateStatus": { "required": [ "id", "title" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" } } }, "MitreTacticXTechnique": { "required": [ "tactic", "techniques" ], "type": "object", "properties": { "tactic": { "$ref": "#/components/schemas/MitreTactic" }, "techniques": { "type": "array", "items": { "$ref": "#/components/schemas/MitreTechniqueDto" } } } }, "MaturityModel": { "required": [ "description", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } }, "MaturityScore": { "required": [ "label", "model", "score" ], "type": "object", "properties": { "model": { "type": "string" }, "label": { "type": "string" }, "score": { "type": "number", "format": "double" }, "description": { "type": "string" } } }, "TagTagGroupAssessmentFilterParams": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "frameworkIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "validOrganizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "AssessmentSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "identifier": { "type": "string" }, "frameworkId": { "type": "string", "format": "uuid" }, "frameworkName": { "type": "string" }, "frameworkVersion": { "type": "string" }, "owner": { "$ref": "#/components/schemas/UserDto2" }, "ownerId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "maturityModel": { "type": "string" }, "currentScore": { "type": "number" }, "cyberstrongScore": { "type": "integer", "format": "int32" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentTagDto2" } }, "percentComplete": { "type": "integer", "format": "int32" }, "lastUpdated": { "type": "string", "format": "date-time" }, "assessmentScoreMethod": { "type": "string", "enum": [ "DFARS_171A", "RAW_CONTROL_FAMILY", "RAW_LEVELED_CONTROL_FAMILY", "RAW_PARENT_CONTROL_LABEL", "RAW", "CONTROL_FAMILY", "PARENT_CONTROL_LABEL", "CYBERSTRONG", "CMMC_2" ] }, "frameworkType": { "type": "string", "enum": [ "Regulatory", "Binary" ] }, "canCrosswalk": { "type": "boolean" }, "hasAutomatedAssessmentDefinition": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "workflowStatus": { "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "formattedAssessmentScore": { "type": "string" } } }, "AssessmentTagDto2": { "required": [ "assessmentId", "assessmentTagGroupId", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "assessmentTagGroupId": { "type": "string", "format": "uuid" } } }, "AssessmentTagGroup": { "required": [ "customerId", "id", "name", "required" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "required": { "type": "boolean" } } }, "TagTagGroupAssessments": { "required": [ "assessments", "tag", "tagGroup" ], "type": "object", "properties": { "tag": { "$ref": "#/components/schemas/AssessmentTag" }, "tagGroup": { "$ref": "#/components/schemas/AssessmentTagGroup" }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentSummary" } } } }, "AvailableFrameworksResponse": { "required": [ "id", "name", "scoreModel", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "scoreModel": { "$ref": "#/components/schemas/ScoreModel" }, "version": { "type": "string" }, "type": { "type": "string", "enum": [ "Regulatory", "Binary" ] } } }, "AssessmentTagAssessment": { "required": [ "assessmentId", "assessmentTagId" ], "type": "object", "properties": { "assessmentId": { "type": "string", "format": "uuid" }, "assessmentTagId": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "string", "format": "date-time" } } }, "AssessmentTagGroupSelectionDto": { "required": [ "assessmentTagGroup", "assessmentTags", "selectedTags" ], "type": "object", "properties": { "assessmentTagGroup": { "$ref": "#/components/schemas/AssessmentTagGroup" }, "assessmentTags": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentTag" } }, "selectedTags": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentTagAssessment" } } } }, "ControlScoreConfigResponse": { "required": [ "reminderUsers" ], "type": "object", "properties": { "reminderUsers": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } } } }, "AppAccess": { "required": [ "roles", "userLinks" ], "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/components/schemas/AppRoles" } }, "userLinks": { "type": "array", "items": { "$ref": "#/components/schemas/UserLinks" } } } }, "AppRoles": { "required": [ "description", "role" ], "type": "object", "properties": { "description": { "type": "string" }, "role": { "type": "string" } } }, "LoggedInUser": { "required": [ "appAccess", "bahRiskModelEnabled", "centralArtifactRepoAccess", "customerId", "email", "firstName", "id", "isGlobalAdmin", "isUsing2FA", "lastName", "organizationalUnitId", "roleIds" ], "type": "object", "properties": { "appAccess": { "$ref": "#/components/schemas/AppAccess" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "isUsing2FA": { "type": "boolean" }, "isGlobalAdmin": { "type": "boolean" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "id": { "type": "string", "format": "uuid" }, "bahRiskModelEnabled": { "type": "boolean" }, "authenticationGroupId": { "type": "string", "format": "uuid" }, "authenticationMethodId": { "type": "string", "format": "uuid" }, "centralArtifactRepoAccess": { "type": "boolean" }, "roleIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "UserLinks": { "required": [ "href", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "href": { "type": "string" } } }, "IntegrationSource": { "required": [ "enabled", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "boolean" } } }, "IntegrationPolicy": { "required": [ "externalIntegrationId", "id", "name", "sourceId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "externalIntegrationId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "sourceId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" } } }, "IbmLocationDto": { "required": [ "location", "region" ], "type": "object", "properties": { "location": { "type": "string" }, "region": { "type": "string" } } }, "IbmInstance": { "required": [ "crn", "family", "name", "type" ], "type": "object", "properties": { "id": { "type": "string" }, "serviceName": { "type": "string" }, "location": { "type": "string" }, "scope": { "type": "string" }, "crn": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "family": { "type": "string" } } }, "IbmAttachment": { "required": [ "id", "name", "profileId", "profileName", "profileVersion", "schedule", "status" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "profileId": { "type": "string" }, "profileVersion": { "type": "string" }, "profileName": { "type": "string" }, "scope": { "type": "array", "items": { "$ref": "#/components/schemas/IbmScopeSummary" } }, "status": { "type": "string" }, "schedule": { "type": "string" } } }, "IbmScopeSummary": { "type": "object", "properties": { "environment": { "type": "string" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/IbmScopeSummaryProp" } } } }, "IbmScopeSummaryProp": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "object" } } }, "GroupSummary": { "required": [ "customerId", "id", "name", "organizationalUnitId", "roleId", "userIds" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "roleId": { "type": "string", "format": "uuid" }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PageGroupSummary": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/GroupSummary" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "FrameworkSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "version": { "type": "string" }, "status": { "type": "string", "enum": [ "Draft", "Published", "Disabled" ] }, "description": { "type": "string" }, "controlCount": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "Regulatory", "Binary" ] }, "customerId": { "type": "string", "format": "uuid" } } }, "GovernanceWidgetResponse": { "required": [ "controlFamily", "controlFamilyCompare", "csfCategory", "csfCategoryCompare", "csfFunction", "csfFunctionCompare", "cybersecurityFrameworkId", "cybersecurityFrameworkName", "dashboardWidgetId", "frameworks", "id", "max", "min", "name", "order", "tags", "tick" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "csfCategoryChart": { "$ref": "#/components/schemas/CsfCategoryItems" }, "csfFunctionChart": { "$ref": "#/components/schemas/CsfFunctionItems" }, "controlFamilyChart": { "$ref": "#/components/schemas/ControlFamilyItems" }, "csfCategoryComparisonChart": { "$ref": "#/components/schemas/CsfCategoryComparisonChart" }, "csfFunctionComparisonChart": { "$ref": "#/components/schemas/CsfFunctionComparisonChart" }, "controlFamilyComparisonChart": { "$ref": "#/components/schemas/ControlFamilyComparisonChart" }, "name": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagIdName" } }, "cybersecurityFrameworkId": { "type": "string", "format": "uuid" }, "cybersecurityFrameworkName": { "type": "string" }, "frameworks": { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkSummary" } }, "dashboardWidgetId": { "type": "string", "format": "uuid" }, "controlFamily": { "type": "boolean" }, "csfFunction": { "type": "boolean" }, "csfCategory": { "type": "boolean" }, "controlFamilyCompare": { "type": "boolean" }, "csfFunctionCompare": { "type": "boolean" }, "csfCategoryCompare": { "type": "boolean" }, "min": { "type": "number" }, "max": { "type": "number" }, "tick": { "type": "number" }, "compareDateOne": { "type": "string", "format": "date-time" }, "compareDateTwo": { "type": "string", "format": "date-time" }, "order": { "type": "integer", "format": "int32" } } }, "TagIdName": { "required": [ "groupId", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "groupId": { "type": "string", "format": "uuid" } } }, "CSFOverTimeWidget": { "required": [ "cybersecurityFrameworkId", "cybersecurityFrameworkName", "dashboardWidgetId", "frameworks", "max", "min", "name", "tags", "tick" ], "type": "object", "properties": { "csfCategoryComparisonChart": { "$ref": "#/components/schemas/CsfCategoryComparisonChart" }, "csfFunctionComparisonChart": { "$ref": "#/components/schemas/CsfFunctionComparisonChart" }, "controlFamilyComparisonChart": { "$ref": "#/components/schemas/ControlFamilyComparisonChart" }, "name": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagIdName" } }, "cybersecurityFrameworkId": { "type": "string", "format": "uuid" }, "cybersecurityFrameworkName": { "type": "string" }, "frameworks": { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkSummary" } }, "dashboardWidgetId": { "type": "string", "format": "uuid" }, "min": { "type": "number" }, "max": { "type": "number" }, "tick": { "type": "number" }, "compareDateOne": { "type": "string", "format": "date-time" }, "compareDateTwo": { "type": "string", "format": "date-time" } } }, "CybersecurityFramework": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" } } }, "GovernanceDashboardWidgetConfig": { "required": [ "assessmentTags", "cybersecurityFrameworks", "frameworks" ], "type": "object", "properties": { "frameworks": { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkSummary" } }, "assessmentTags": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentTagGroupAndTagsDto" } }, "cybersecurityFrameworks": { "type": "array", "items": { "$ref": "#/components/schemas/CybersecurityFramework" } } } }, "GovernanceDashboardSummaryFilters": { "type": "object", "properties": { "dashboardName": { "type": "string" }, "organizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "GovernanceDashboardSummary": { "required": [ "id", "name", "organizationalUnitId", "widgetCount" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "widgetCount": { "type": "integer", "format": "int32" } } }, "PageImplGovernanceDashboardSummary": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/GovernanceDashboardSummary" } }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "last": { "type": "boolean" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "GovernanceDashboardPageResponse": { "type": "object", "properties": { "governanceDashboardPage": { "$ref": "#/components/schemas/GovernanceDashboardPage" } } }, "CustomerPublishedFramework": { "required": [ "assessmentScoreMethod", "controlScoreMethod", "id", "name", "scoreModel" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "scoreModel": { "$ref": "#/components/schemas/ScoreModel" }, "assessmentScoreMethod": { "type": "string", "enum": [ "DFARS_171A", "RAW_CONTROL_FAMILY", "RAW_LEVELED_CONTROL_FAMILY", "RAW_PARENT_CONTROL_LABEL", "RAW", "CONTROL_FAMILY", "PARENT_CONTROL_LABEL", "CYBERSTRONG", "CMMC_2" ] }, "controlScoreMethod": { "type": "string", "enum": [ "BINARY", "LEVEL", "REGULATORY", "CMMC_2" ] }, "version": { "type": "string" } } }, "FrameworkMaturityDto": { "required": [ "framework", "maxScore", "minScore" ], "type": "object", "properties": { "framework": { "$ref": "#/components/schemas/Framework" }, "currentScoreAverage": { "type": "number" }, "targetScoreAverage": { "type": "number" }, "minScore": { "type": "number" }, "maxScore": { "type": "number" } } }, "FrameworkAssessmentsFilterParams": { "type": "object", "properties": { "frameworkIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "name": { "type": "string" }, "validOrganizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "FrameworkAssessments": { "required": [ "assessments", "framework" ], "type": "object", "properties": { "framework": { "$ref": "#/components/schemas/Framework" }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/Assessment" } } } }, "IntegrationControlEntry": { "required": [ "controlFamily", "controlId", "controlLabel", "key" ], "type": "object", "properties": { "key": { "type": "string" }, "controlId": { "type": "string", "format": "uuid" }, "controlActionId": { "type": "string", "format": "uuid" }, "controlFamily": { "type": "string" }, "controlLabel": { "type": "string" }, "controlActionContent": { "type": "string" } } }, "AssessmentMetadataFieldDto": { "required": [ "assessmentMetadataFieldValue" ], "type": "object", "properties": { "assessmentMetadataFieldValue": { "$ref": "#/components/schemas/AssessmentMetadataFieldValue" }, "frameworkMetadataField": { "$ref": "#/components/schemas/FrameworkMetadataField" } } }, "AssessmentMetadataFieldValue": { "required": [ "assessmentId", "frameworkMetadataFieldId", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "value": { "type": "string" }, "frameworkMetadataFieldId": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" } } }, "FrameworkSearchMetadata": { "required": [ "statusList", "versionList" ], "type": "object", "properties": { "versionList": { "type": "array", "items": { "type": "string" } }, "statusList": { "type": "array", "items": { "type": "string", "enum": [ "Draft", "Published", "Disabled" ] } } } }, "ControlActionScoreGuidance": { "required": [ "controlActionId", "customerId", "frameworkId", "id", "scoreGuidanceSetsId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "frameworkId": { "type": "string", "format": "uuid" }, "controlActionId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "scoreGuidanceSetsId": { "type": "string", "format": "uuid" } } }, "FrameworkConfiguration": { "required": [ "customerId", "frameworkId", "roleConfigurations" ], "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid" }, "frameworkId": { "type": "string", "format": "uuid" }, "roleConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkRoleConfiguration" } } } }, "FrameworkRoleConfiguration": { "required": [ "restrictedFeatureKeys", "roleId" ], "type": "object", "properties": { "roleId": { "type": "string", "format": "uuid" }, "restrictedFeatureKeys": { "type": "array", "items": { "type": "string" } } } }, "FrameworkConfigDefinition": { "required": [ "domains" ], "type": "object", "properties": { "domains": { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkConfigDomain" } } } }, "FrameworkConfigDomain": { "required": [ "description", "features", "key", "tooltip" ], "type": "object", "properties": { "key": { "type": "string", "enum": [ "SCORING" ] }, "description": { "type": "string" }, "tooltip": { "type": "string" }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkConfigFeature" } } } }, "FrameworkConfigFeature": { "required": [ "configDomainKey", "description", "key", "tooltip" ], "type": "object", "properties": { "key": { "type": "string", "enum": [ "CURRENT_SCORE", "TARGET_SCORE" ] }, "description": { "type": "string" }, "tooltip": { "type": "string" }, "configDomainKey": { "type": "string", "enum": [ "SCORING" ] } } }, "FindingDto": { "required": [ "aleTotal", "controlFamily", "controlIdentifier", "customerId", "findingIdentifier", "id", "organizationalUnitId", "parentControlLabel", "risks", "sourceId", "sourceName" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "sourceId": { "type": "string", "format": "uuid" }, "sourceName": { "type": "string" }, "controlIdentifier": { "type": "string" }, "controlFamily": { "type": "string" }, "parentControlLabel": { "type": "string" }, "findingIdentifier": { "type": "string" }, "aleTotal": { "type": "number" }, "risks": { "type": "array", "items": { "type": "string" } } } }, "FairResidualRisk": { "required": [ "customerId", "effectiveDate", "fairRiskId", "lossCurve", "lossFrequencyMaxEvents", "lossFrequencyMaxYears", "lossFrequencyMinEvents", "lossFrequencyMinYears", "lossFrequencyMostLikelyEvents", "lossFrequencyMostLikelyYears", "lossMagnitudeMax", "lossMagnitudeMin", "lossMagnitudeMostLikely", "maximum", "mean", "minimum", "mostLikely", "ninetyPercentile", "probabilityCurve", "riskDistributionCurve", "simulationHistogram", "stdev", "tenPercentile" ], "type": "object", "properties": { "fairRiskId": { "type": "string", "format": "uuid" }, "effectiveDate": { "type": "string", "format": "date-time" }, "customerId": { "type": "string", "format": "uuid" }, "lossMagnitudeMostLikely": { "type": "integer", "format": "int64" }, "lossFrequencyMostLikelyEvents": { "type": "number", "format": "double" }, "lossFrequencyMostLikelyYears": { "type": "number", "format": "double" }, "lossMagnitudeMin": { "type": "integer", "format": "int64" }, "lossFrequencyMinEvents": { "type": "number", "format": "double" }, "lossFrequencyMinYears": { "type": "number", "format": "double" }, "lossMagnitudeMax": { "type": "integer", "format": "int64" }, "lossFrequencyMaxEvents": { "type": "number", "format": "double" }, "lossFrequencyMaxYears": { "type": "number", "format": "double" }, "lossCurve": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } }, "probabilityCurve": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } }, "riskDistributionCurve": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } }, "simulationHistogram": { "type": "array", "items": { "type": "number", "format": "double" } }, "stdev": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "mean": { "type": "number" }, "mostLikely": { "type": "number" }, "ninetyPercentile": { "type": "number" }, "tenPercentile": { "type": "number" } } }, "FairRiskAnalytic": { "required": [ "fairRiskId", "lossCurve", "maximum", "mean", "minimum", "mostLikely", "ninetyPercentile", "probabilityCurve", "riskDistributionCurve", "simulationHistogram", "stdev", "tenPercentile" ], "type": "object", "properties": { "fairRiskId": { "type": "string", "format": "uuid" }, "lossCurve": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } }, "probabilityCurve": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } }, "riskDistributionCurve": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } }, "simulationHistogram": { "type": "array", "items": { "type": "number", "format": "double" } }, "stdev": { "type": "number" }, "minimum": { "type": "number" }, "maximum": { "type": "number" }, "mean": { "type": "number" }, "mostLikely": { "type": "number" }, "ninetyPercentile": { "type": "number" }, "tenPercentile": { "type": "number" } } }, "FairRiskAndOwnersDto": { "required": [ "analytic", "associatedControlIds", "associatedControlScoreIds", "createdByUser", "details", "fairRisk", "lastUpdatedByUser", "owners", "risk" ], "type": "object", "properties": { "fairRisk": { "$ref": "#/components/schemas/FairRisk" }, "details": { "$ref": "#/components/schemas/FairRiskDetailsDto" }, "analytic": { "$ref": "#/components/schemas/FairRiskAnalytic" }, "risk": { "$ref": "#/components/schemas/Risk" }, "riskTreatmentPlan": { "$ref": "#/components/schemas/RiskTreatmentPlan" }, "createdByUser": { "$ref": "#/components/schemas/BasicUserDto" }, "lastUpdatedByUser": { "$ref": "#/components/schemas/BasicUserDto" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } }, "associatedControlIds": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWithScores" } }, "associatedControlScoreIds": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWithScoreControlScore" } }, "fairResidualRisk": { "$ref": "#/components/schemas/FairResidualRisk" } } }, "FairRiskDetailsDto": { "required": [ "fairRiskId", "id", "primaryLoss", "secondaryLm" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fairRiskId": { "type": "string", "format": "uuid" }, "threatFrequencyMinEvents": { "type": "number", "format": "double" }, "threatFrequencyMinYears": { "type": "number", "format": "double" }, "threatFrequencyMaxEvents": { "type": "number", "format": "double" }, "threatFrequencyMaxYears": { "type": "number", "format": "double" }, "threatFrequencyMostLikelyEvents": { "type": "number", "format": "double" }, "threatFrequencyMostLikelyYears": { "type": "number", "format": "double" }, "threatFrequencyDescription": { "type": "string" }, "vulnerabilityMin": { "type": "number" }, "vulnerabilityMax": { "type": "number" }, "vulnerabilityMostLikely": { "type": "number" }, "vulnerabilityDescription": { "type": "string" }, "contactFrequencyMinEvents": { "type": "number", "format": "double" }, "contactFrequencyMinYears": { "type": "number", "format": "double" }, "contactFrequencyMaxEvents": { "type": "number", "format": "double" }, "contactFrequencyMaxYears": { "type": "number", "format": "double" }, "contactFrequencyMostLikelyEvents": { "type": "number", "format": "double" }, "contactFrequencyMostLikelyYears": { "type": "number", "format": "double" }, "contactFrequencyDescription": { "type": "string" }, "probabilityOfActionMin": { "type": "number" }, "probabilityOfActionMax": { "type": "number" }, "probabilityOfActionMostLikely": { "type": "number" }, "probabilityOfActionDescription": { "type": "string" }, "threatCapabilityMin": { "type": "number" }, "threatCapabilityMax": { "type": "number" }, "threatCapabilityMostLikely": { "type": "number" }, "threatCapabilityDescription": { "type": "string" }, "resistanceStrengthMin": { "type": "number" }, "resistanceStrengthMax": { "type": "number" }, "resistanceStrengthMostLikely": { "type": "number" }, "resistanceStrengthDescription": { "type": "string" }, "primaryLoss": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryLoss" } }, "primaryLossDescription": { "type": "string" }, "secondaryLefMin": { "type": "number" }, "secondaryLefMax": { "type": "number" }, "secondaryLefMostLikely": { "type": "number" }, "secondaryLefDescription": { "type": "string" }, "secondaryLm": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryLoss" } }, "secondaryLmDescription": { "type": "string" } } }, "Changes": { "required": [ "effectiveDate", "isExcluded" ], "type": "object", "properties": { "effectiveDate": { "type": "string", "format": "date-time" }, "score": { "type": "number", "format": "float" }, "scoreLabel": { "type": "string" }, "previousScore": { "type": "number", "format": "float" }, "previousScoreLabel": { "type": "string" }, "previousEffectiveDate": { "type": "string", "format": "date-time" }, "isExcluded": { "type": "boolean" }, "previousIsExcluded": { "type": "boolean" } } }, "ControlScoreChanges": { "required": [ "assessmentId", "assessmentName", "changes", "controlFamily", "controlId", "controlLabel", "controlScoreId" ], "type": "object", "properties": { "assessmentName": { "type": "string" }, "assessmentId": { "type": "string", "format": "uuid" }, "controlId": { "type": "string", "format": "uuid" }, "controlScoreId": { "type": "string", "format": "uuid" }, "controlFamily": { "type": "string" }, "controlLabel": { "type": "string" }, "parentControlLabel": { "type": "string" }, "auxiliaryControlLabel": { "type": "string" }, "score": { "type": "number", "format": "float" }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/Changes" } } } }, "ControlWithControlScoreChanges": { "required": [ "controlFamily", "controlId", "controlLabel", "controlScores" ], "type": "object", "properties": { "controlId": { "type": "string", "format": "uuid" }, "controlFamily": { "type": "string" }, "controlLabel": { "type": "string" }, "parentControlLabel": { "type": "string" }, "auxiliaryControlLabel": { "type": "string" }, "controlScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreChanges" } } } }, "FairRiskMetaModel": { "required": [ "inherentLossCurve", "inherentRiskDistributionCurve", "inherentRiskStats", "residualLossCurve", "residualRiskDistributionCurve" ], "type": "object", "properties": { "inherentLossCurve": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "inherentRiskDistributionCurve": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "inherentRiskStats": { "$ref": "#/components/schemas/FairRiskStats" }, "residualLossCurve": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "residualRiskDistributionCurve": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "residualRiskStats": { "$ref": "#/components/schemas/FairRiskStats" } } }, "FairRiskStats": { "required": [ "maximum", "mean", "minimum", "mostLikely", "ninetyPercentile", "tenPercentile" ], "type": "object", "properties": { "minimum": { "type": "number" }, "maximum": { "type": "number" }, "mean": { "type": "number" }, "mostLikely": { "type": "number" }, "ninetyPercentile": { "type": "number" }, "tenPercentile": { "type": "number" } } }, "AdvisenAttackVector": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "RiskAndAle": { "required": [ "ale", "risk" ], "type": "object", "properties": { "risk": { "$ref": "#/components/schemas/Risk" }, "ale": { "type": "integer", "format": "int64" } } }, "RisksByCategory": { "required": [ "category", "risksAndAles", "sumAle" ], "type": "object", "properties": { "category": { "$ref": "#/components/schemas/AdvisenAttackVector" }, "risksAndAles": { "type": "array", "items": { "$ref": "#/components/schemas/RiskAndAle" } }, "sumAle": { "type": "integer", "format": "int64" } } }, "ExecutiveDashboardListFilterParams": { "type": "object", "properties": { "dashboardName": { "type": "string" }, "organizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PageImplExecutiveDashboardDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutiveDashboardDto" } }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "last": { "type": "boolean" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "AllAssessmentAvgAtDate": { "required": [ "date" ], "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "currentAvg": { "type": "number" } } }, "AssessmentHistoryAtDate": { "required": [ "assessmentId", "date", "effectiveDate", "name" ], "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "current": { "type": "number" }, "target": { "type": "number" }, "assessmentId": { "type": "string", "format": "uuid" }, "effectiveDate": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "identifier": { "type": "string" } } }, "AssessmentStatistic": { "required": [ "id", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "currentAvg": { "type": "number" }, "targetAvg": { "type": "number" }, "id": { "type": "string", "format": "uuid" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentHistoryAtDate" } } } }, "ExecutiveDashboardCsfMaturityDto": { "required": [ "industryOverallAvg", "overallHistory", "scoredControls", "totalControls" ], "type": "object", "properties": { "totalControls": { "type": "integer", "format": "int32" }, "scoredControls": { "type": "integer", "format": "int32" }, "avgControlScoreGap": { "type": "number" }, "avgAssessmentCurrentScore": { "type": "number" }, "avgAssessmentTargetScore": { "type": "number" }, "topPerformingAssessment": { "$ref": "#/components/schemas/AssessmentStatistic" }, "lowPerformingAssessment": { "$ref": "#/components/schemas/AssessmentStatistic" }, "overallHistory": { "type": "array", "items": { "$ref": "#/components/schemas/AllAssessmentAvgAtDate" } }, "industryOverallAvg": { "type": "number" } } }, "DataLakeTemplate": { "required": [ "frameworkId", "lastUpdated", "name", "sourceId", "updatedBy" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "frameworkId": { "type": "string", "format": "uuid" }, "frameworkName": { "type": "string" }, "frameworkVersion": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "customerName": { "type": "string" }, "updatedBy": { "type": "string", "format": "uuid" }, "lastUpdated": { "type": "string", "format": "date-time" }, "sourceId": { "type": "string", "format": "uuid" }, "sourceName": { "type": "string" } } }, "PageDataLakeTemplate": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeTemplate" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "DataLakeAdHocQueryDto": { "required": [ "database", "id", "query", "schema", "sourceId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "query": { "type": "string" }, "sourceId": { "type": "string", "format": "uuid" }, "database": { "type": "string" }, "schema": { "type": "string" }, "warehouse": { "type": "string" } } }, "DataLakeEntriesDto": { "required": [ "adHocQueries", "controlFamilyName", "controlId", "controlName", "key", "templatedQueries" ], "type": "object", "properties": { "key": { "type": "string" }, "controlId": { "type": "string", "format": "uuid" }, "controlActionId": { "type": "string", "format": "uuid" }, "controlName": { "type": "string" }, "controlFamilyName": { "type": "string" }, "controlActionContent": { "type": "string" }, "adHocQueries": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeAdHocQueryDto" } }, "templatedQueries": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeTemplatedQueryDto" } } } }, "DataLakeTemplatedQueryDto": { "required": [ "database", "id", "params", "query", "queryTemplateId", "queryTemplateName", "schema", "sourceId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "queryTemplateId": { "type": "string", "format": "uuid" }, "queryTemplateName": { "type": "string" }, "sourceId": { "type": "string", "format": "uuid" }, "query": { "type": "string" }, "database": { "type": "string" }, "schema": { "type": "string" }, "warehouse": { "type": "string" }, "params": { "type": "object", "additionalProperties": { "type": "object" } } } }, "DataLakeEntriesTemplatedDto": { "required": [ "controlFamilyName", "controlId", "controlName", "key", "queries" ], "type": "object", "properties": { "key": { "type": "string" }, "controlId": { "type": "string", "format": "uuid" }, "controlActionId": { "type": "string", "format": "uuid" }, "controlName": { "type": "string" }, "controlFamilyName": { "type": "string" }, "controlActionContent": { "type": "string" }, "queries": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeTemplatedQueryDto" } } } }, "DataLakeEntriesAdHocDto": { "required": [ "adHoc", "controlFamilyName", "controlId", "controlName", "key", "queries" ], "type": "object", "properties": { "adHoc": { "type": "boolean" }, "key": { "type": "string" }, "controlId": { "type": "string", "format": "uuid" }, "controlActionId": { "type": "string", "format": "uuid" }, "controlName": { "type": "string" }, "controlFamilyName": { "type": "string" }, "controlActionContent": { "type": "string" }, "queries": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeAdHocQueryDto" } } } }, "DataLakeQueryTemplate": { "required": [ "customerId", "database", "frameworkId", "name", "query", "schema", "sourceId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "sourceId": { "type": "string", "format": "uuid" }, "sourceName": { "type": "string" }, "frameworkId": { "type": "string", "format": "uuid" }, "frameworkName": { "type": "string" }, "frameworkVersion": { "type": "string" }, "query": { "type": "string" }, "database": { "type": "string" }, "schema": { "type": "string" }, "warehouse": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" } } }, "PageDataLakeQueryTemplate": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/DataLakeQueryTemplate" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "CyberInsightTemplateDto": { "required": [ "controlSize", "cyberInsightTemplate", "frameworks" ], "type": "object", "properties": { "cyberInsightTemplate": { "$ref": "#/components/schemas/CyberInsightTemplate" }, "frameworks": { "type": "array", "items": { "$ref": "#/components/schemas/Framework" } }, "controlSize": { "type": "integer", "format": "int32" } } }, "PageCyberInsightTemplateDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/CyberInsightTemplateDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "CyberInsightRiskScorePopulated": { "type": "object", "properties": { "optionSet": { "$ref": "#/components/schemas/BahOptionSetPopulated" }, "option": { "$ref": "#/components/schemas/BahOption" }, "note": { "type": "string" } } }, "CyberInsightTemplateAnswersDto": { "required": [ "cyberInsightTemplate", "scores" ], "type": "object", "properties": { "cyberInsightTemplate": { "$ref": "#/components/schemas/CyberInsightTemplate" }, "scores": { "type": "array", "items": { "$ref": "#/components/schemas/CyberInsightRiskScorePopulated" } }, "controls": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "mitreTechniqueDtos": { "type": "array", "items": { "$ref": "#/components/schemas/MitreTechniqueDto" } } } }, "ControlFrameworkAndCsfFunctionsDto": { "required": [ "control", "csfFunctions", "frameworks" ], "type": "object", "properties": { "control": { "$ref": "#/components/schemas/Control" }, "frameworks": { "type": "array", "items": { "$ref": "#/components/schemas/Framework" } }, "csfFunctions": { "type": "array", "items": { "$ref": "#/components/schemas/CsfFunction" } } } }, "Currency": { "required": [ "code", "name", "symbol" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "symbol": { "type": "string" } } }, "CustomerConfig": { "required": [ "currency", "customerDashboard", "executiveDashboardEnabled", "jiraEnabled", "knightVisionEnabled", "sspEnabled" ], "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/Currency" }, "customerDashboard": { "$ref": "#/components/schemas/CustomerDashboard" }, "jiraEnabled": { "type": "boolean" }, "executiveDashboardEnabled": { "type": "boolean" }, "sspEnabled": { "type": "boolean" }, "productPackageId": { "type": "string", "format": "uuid" }, "knightVisionEnabled": { "type": "boolean" } } }, "CustomerDashboard": { "required": [ "customerId", "id", "lastUpdatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "sectorId": { "type": "string", "format": "uuid" }, "employeeCount": { "type": "integer", "format": "int64" }, "revenue": { "type": "integer", "format": "int64" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "advisenSecondaryIndustryId": { "type": "string", "format": "uuid" } } }, "AdminCustomerConfig": { "required": [ "currency", "currencyOptions", "customerDashboard", "customerDefaults", "knightVisionEnabled", "sessionTimeoutSeconds" ], "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/Currency" }, "currencyOptions": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } }, "customerDashboard": { "$ref": "#/components/schemas/CustomerDashboard" }, "jiraConfig": { "$ref": "#/components/schemas/JiraConfig" }, "customerDefaults": { "$ref": "#/components/schemas/CustomerDefaults" }, "sessionTimeoutSeconds": { "type": "integer", "format": "int32" }, "productPackageId": { "type": "string", "format": "uuid" }, "knightVisionEnabled": { "type": "boolean" } } }, "CustomReportSummaryFilters": { "required": [ "favoritesOnly" ], "type": "object", "properties": { "name": { "type": "string" }, "reportTypeId": { "type": "string", "format": "uuid" }, "favoritesOnly": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "organizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "sortKey": { "type": "string" }, "sortValue": { "type": "string" } } }, "CustomReport": { "required": [ "customReportTypeId", "customerId", "id", "isFavorite", "lastUpdated", "name", "organizationalUnitId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "customReportTypeId": { "type": "string", "format": "uuid" }, "customerId": { "type": "string", "format": "uuid" }, "isFavorite": { "type": "boolean" }, "lastUpdated": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" } } }, "CustomReportSummaryDto": { "required": [ "customReport", "reportType" ], "type": "object", "properties": { "customReport": { "$ref": "#/components/schemas/CustomReport" }, "reportType": { "$ref": "#/components/schemas/CustomReportType" }, "lastPulled": { "type": "string", "format": "date-time" } } }, "CustomReportType": { "required": [ "defaultField", "description", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "defaultField": { "type": "string" } } }, "PageImplCustomReportSummaryDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/CustomReportSummaryDto" } }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "last": { "type": "boolean" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "CustomReportPreviewDto": { "required": [ "fieldNames", "values" ], "type": "object", "properties": { "fieldNames": { "type": "array", "items": { "type": "string" } }, "values": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } }, "CustomReportFieldDto": { "required": [ "example", "id", "instanceValue", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "example": { "type": "string" }, "instanceValue": { "type": "string" }, "parentId": { "type": "string", "format": "uuid" } } }, "FrameworkIdAndMetadataFieldIdDto": { "required": [ "frameworkId", "metadataFieldId" ], "type": "object", "properties": { "frameworkId": { "type": "string", "format": "uuid" }, "metadataFieldId": { "type": "string", "format": "uuid" } } }, "CrosswalkTemplateSearchParams": { "type": "object", "properties": { "templateNameSearch": { "type": "string" }, "isPublished": { "type": "boolean" }, "fromFrameworkFilter": { "type": "string" }, "toFrameworkFilter": { "type": "string" }, "isPublic": { "type": "boolean" } } }, "CrosswalkTemplateAndFrameworksDto": { "required": [ "crosswalkTemplate", "crosswalkTemplateMappings", "fromFramework", "toFramework" ], "type": "object", "properties": { "crosswalkTemplate": { "$ref": "#/components/schemas/CrosswalkTemplate" }, "crosswalkTemplateMappings": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkTemplateMapping" } }, "fromFramework": { "$ref": "#/components/schemas/Framework" }, "toFramework": { "$ref": "#/components/schemas/Framework" } } }, "PageCrosswalkTemplateAndFrameworksDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkTemplateAndFrameworksDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "CrosswalkTemplateSearchOptions": { "required": [ "fromFrameworks", "toFrameworks" ], "type": "object", "properties": { "fromFrameworks": { "type": "array", "items": { "$ref": "#/components/schemas/Framework" } }, "toFrameworks": { "type": "array", "items": { "$ref": "#/components/schemas/Framework" } } } }, "CrosswalkMapping": { "required": [ "fromControlId", "fromFrameworkId", "fromId", "toControlId", "toFrameworkId", "toId" ], "type": "object", "properties": { "fromFrameworkId": { "type": "string", "format": "uuid" }, "fromId": { "type": "string", "format": "uuid" }, "toFrameworkId": { "type": "string", "format": "uuid" }, "toId": { "type": "string", "format": "uuid" }, "confidence": { "type": "number" }, "fromControlId": { "type": "string", "format": "uuid" }, "toControlId": { "type": "string", "format": "uuid" }, "fromControlActionId": { "type": "string", "format": "uuid" }, "toControlActionId": { "type": "string", "format": "uuid" }, "toControlActionIdx": { "type": "integer", "format": "int32" } } }, "CrosswalkMappingFullDto": { "required": [ "crosswalkMapping", "fromControl", "fromFramework", "toControl", "toFramework" ], "type": "object", "properties": { "crosswalkMapping": { "$ref": "#/components/schemas/CrosswalkMapping" }, "fromFramework": { "$ref": "#/components/schemas/Framework" }, "toFramework": { "$ref": "#/components/schemas/Framework" }, "fromControl": { "$ref": "#/components/schemas/Control" }, "toControl": { "$ref": "#/components/schemas/Control" }, "fromControlAction": { "$ref": "#/components/schemas/ControlAction" }, "toControlAction": { "$ref": "#/components/schemas/ControlAction" } } }, "CrosswalkTemplateAndMappingDto": { "required": [ "crosswalkTemplate", "crosswalkTemplateMappingDtos" ], "type": "object", "properties": { "crosswalkTemplate": { "$ref": "#/components/schemas/CrosswalkTemplate" }, "crosswalkTemplateMappingDtos": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkTemplateMappingDto" } } } }, "CrosswalkTemplateMappingDto": { "required": [ "crosswalkTemplateMapping" ], "type": "object", "properties": { "crosswalkTemplateMapping": { "$ref": "#/components/schemas/CrosswalkTemplateMapping" }, "crosswalkMappingFullDto": { "$ref": "#/components/schemas/CrosswalkMappingFullDto" } } }, "ControlAndCsfFunctionFilterParams": { "required": [ "filterCsfFunctions", "filterFrameworks", "filteredControlIds" ], "type": "object", "properties": { "filteredControlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "controlNameSearch": { "type": "string" }, "filterCsfFunctions": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "filterFrameworks": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PageControlFrameworkAndCsfFunctionsDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ControlFrameworkAndCsfFunctionsDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "ControlSearchConfig": { "required": [ "frameworks" ], "type": "object", "properties": { "frameworks": { "type": "array", "items": { "$ref": "#/components/schemas/Framework" } } } }, "ControlScoreActionStatus": { "required": [ "readOnly", "reasons" ], "type": "object", "properties": { "reasons": { "type": "array", "items": { "type": "string", "enum": [ "USER_ROLE", "CROSSWALK_SYNCED", "ASSESSMENT_COMPLETE" ] } }, "readOnly": { "type": "boolean" } } }, "ControlScoreStatus": { "required": [ "controlScoreActions", "readOnly", "reasons" ], "type": "object", "properties": { "reasons": { "type": "array", "items": { "type": "string", "enum": [ "USER_ROLE", "CROSSWALK_SYNCED", "ASSESSMENT_COMPLETE" ] } }, "controlScoreActions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ControlScoreActionStatus" } }, "readOnly": { "type": "boolean" } } }, "ControlScoreActionIntegrationDto": { "required": [ "controlScoreActionIntegrationSources", "integrationSource" ], "type": "object", "properties": { "controlScoreActionIntegrationSources": { "$ref": "#/components/schemas/ControlScoreActionIntegrationSources" }, "integrationSource": { "$ref": "#/components/schemas/IntegrationSource" } } }, "ControlScoreActionIntegrationSources": { "required": [ "assessmentId", "controlScoreActionId", "sourceId" ], "type": "object", "properties": { "assessmentId": { "type": "string", "format": "uuid" }, "controlScoreActionId": { "type": "string", "format": "uuid" }, "sourceId": { "type": "string", "format": "uuid" } } }, "CrosswalkHistoryAndViewDto": { "required": [ "canUserAccessFromAssessment", "crosswalkHistory", "crosswalkMappingDto" ], "type": "object", "properties": { "crosswalkHistory": { "$ref": "#/components/schemas/CrosswalkHistory" }, "crosswalkMappingDto": { "$ref": "#/components/schemas/CrosswalkMappingDto" }, "canUserAccessFromAssessment": { "type": "boolean" } } }, "CrosswalkMappingDto": { "required": [ "crosswalkMapping", "fromControl" ], "type": "object", "properties": { "crosswalkMapping": { "$ref": "#/components/schemas/CrosswalkMapping" }, "fromControl": { "$ref": "#/components/schemas/Control" }, "fromControlAction": { "$ref": "#/components/schemas/ControlAction" } } }, "ControlActionAndScoreDto": { "required": [ "controlAction", "controlScoreAction", "isScored" ], "type": "object", "properties": { "controlScoreAction": { "$ref": "#/components/schemas/ControlScoreAction" }, "controlAction": { "$ref": "#/components/schemas/ControlAction" }, "isScored": { "type": "boolean" }, "annotation": { "$ref": "#/components/schemas/ControlScoreActionAnnotation" } } }, "ControlScoreActionAndAnnotation": { "required": [ "controlScoreAction" ], "type": "object", "properties": { "controlScoreAction": { "$ref": "#/components/schemas/ControlScoreAction" }, "controlScoreActionAnnotation": { "$ref": "#/components/schemas/ControlScoreActionAnnotation" } } }, "AssessmentPair": { "required": [ "assessmentId", "assessmentName" ], "type": "object", "properties": { "assessmentId": { "type": "string", "format": "uuid" }, "assessmentName": { "type": "string" } } }, "ControlScoreDetailsConfig": { "required": [ "assessmentOptions", "controlWorkflowOptions" ], "type": "object", "properties": { "assessmentOptions": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentPair" } }, "controlWorkflowOptions": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWorkflowPair" } } } }, "ControlWorkflowPair": { "required": [ "controlWorkflowId", "controlWorkflowName" ], "type": "object", "properties": { "controlWorkflowId": { "type": "string", "format": "uuid" }, "controlWorkflowName": { "type": "string" } } }, "ControlSearchResult": { "required": [ "controlActions", "controlFamily", "controlLabel", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "auxiliaryControlLabel": { "type": "string" }, "controlLabel": { "type": "string" }, "controlFamily": { "type": "string" }, "parentControlLabel": { "type": "string" }, "controlActions": { "type": "array", "items": { "$ref": "#/components/schemas/ControlAction" } }, "frameworks": { "type": "array", "items": { "$ref": "#/components/schemas/Framework" } } } }, "PageControlSearchResult": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ControlSearchResult" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "PageConnector": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/Connector" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "ConnectorField": { "required": [ "path", "table", "type" ], "type": "object", "properties": { "table": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string", "enum": [ "BOOLEAN", "INTEGER", "DECIMAL", "VARCHAR", "OBJECT", "BOOLEAN_ARRAY", "INTEGER_ARRAY", "DECIMAL_ARRAY", "VARCHAR_ARRAY", "OBJECT_ARRAY" ] } } }, "SchemaConfig": { "required": [ "script" ], "type": "object", "properties": { "script": { "type": "string" }, "publicKey": { "type": "string" }, "privateKey": { "type": "string" }, "password": { "type": "string" } } }, "ConnectorStats": { "required": [ "assessmentCount", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "assessmentCount": { "type": "integer", "format": "int32" } } }, "ControlWorkflowGroupDefinitionWithOptions": { "required": [ "description", "id", "lastUpdated", "name", "revision", "workflowOptions" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "revision": { "type": "integer", "format": "int32" }, "workflowOptions": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWorkflowOptionDefinition" } } } }, "ControlWorkflowOptionDefinition": { "required": [ "color", "controlDoneFlag", "defaultOptionFlag", "id", "name", "ordinal", "revision", "roles" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "tooltip": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "color": { "type": "string" }, "controlDoneFlag": { "type": "boolean" }, "defaultOptionFlag": { "type": "boolean" }, "lastUpdated": { "type": "string", "format": "date-time" }, "ordinal": { "type": "integer", "format": "int32" }, "revision": { "type": "integer", "format": "int32" } } }, "AzureIntegrationTargetOptions": { "type": "object", "properties": { "managementGroups": { "type": "array", "items": { "$ref": "#/components/schemas/AzureManagementGroupDetails" } }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/AzureSubscriptionDetails" } }, "resourceGroups": { "type": "array", "items": { "$ref": "#/components/schemas/AzureResourceGroup" } } } }, "AzureManagementGroupDetails": { "required": [ "displayName", "id" ], "type": "object", "properties": { "displayName": { "type": "string" }, "id": { "type": "string" } } }, "AzureResourceGroup": { "required": [ "resourceGroup", "subscription", "subscriptionId" ], "type": "object", "properties": { "subscription": { "type": "string" }, "subscriptionId": { "type": "string", "format": "uuid" }, "resourceGroup": { "type": "string" } } }, "AzureSubscriptionDetails": { "required": [ "displayName", "id" ], "type": "object", "properties": { "displayName": { "type": "string" }, "id": { "type": "string", "format": "uuid" } } }, "AutomationVulnerabilityScanHistoryDto": { "required": [ "history" ], "type": "object", "properties": { "lastChecked": { "type": "string", "format": "date-time" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationVulnerabilityScanHistoryEntryDto" } } } }, "AutomationVulnerabilityScanHistoryEntryDto": { "required": [ "effectiveDate", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "scanName": { "type": "string" }, "scanTime": { "type": "string", "format": "date-time" }, "errorMessage": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" } } }, "AssetResultDto": { "required": [ "assetId", "assetName", "result" ], "type": "object", "properties": { "assetId": { "type": "string" }, "assetName": { "type": "string" }, "assetDescription": { "type": "string" }, "connectorId": { "type": "string", "format": "uuid" }, "result": { "type": "boolean" } } }, "AutomationPoliciesHistoryDto": { "required": [ "messages", "policyHistories" ], "type": "object", "properties": { "lastChecked": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "SUCCESS", "PARTIAL", "ERROR" ] }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ScrapeMessageDto" } }, "policyHistories": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationPolicyHistoryDto" } } } }, "AutomationPolicyHistoryDto": { "required": [ "assetResults", "history", "policyId", "policyName" ], "type": "object", "properties": { "policyId": { "type": "string" }, "policyName": { "type": "string" }, "policyDescription": { "type": "string" }, "currentValue": { "type": "string" }, "assetResults": { "type": "array", "items": { "$ref": "#/components/schemas/AssetResultDto" } }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationPolicyHistoryEntryDto" } } } }, "AutomationPolicyHistoryEntryDto": { "required": [ "effectiveDate", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "oldValue": { "type": "string" }, "newValue": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" } } }, "ScrapeMessageDto": { "required": [ "category", "id", "message", "scrapeControlActionId", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "scrapeControlActionId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "Info", "Warning", "Error" ] }, "category": { "type": "string", "enum": [ "API Exception", "Invalid Authentication", "Invalid Automation Definition", "Invalid Query", "Missing Metadata Field", "Missing Metadata Field Value", "Missing Template Field Value", "Other", "Unknown" ] }, "message": { "type": "string" } } }, "AutomationSummaryFilters": { "type": "object", "properties": { "name": { "type": "string" }, "organizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "integrationSource": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "result": { "type": "string" } } }, "AutomationDetails": { "required": [ "assessmentId", "assessmentName", "frequency", "id", "integrationCount", "integrationSourceResults", "organizationalUnitId", "status" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" }, "assessmentName": { "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "Scheduled", "Running", "Paused" ] }, "integrationCount": { "type": "integer", "format": "int32" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "frequency": { "type": "string", "enum": [ "Daily", "Weekly", "Monthly" ] }, "dayOfWeek": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "dayOfMonth": { "type": "integer", "format": "int32" }, "integrationSourceResults": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationSourceResultDto" } } } }, "AutomationMessage": { "required": [ "category", "message", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "Info", "Warning", "Error" ] }, "category": { "type": "string", "enum": [ "API Exception", "Invalid Authentication", "Invalid Automation Definition", "Invalid Query", "Missing Metadata Field", "Missing Metadata Field Value", "Missing Template Field Value", "Other", "Unknown" ] }, "message": { "type": "string" } } }, "ControlActionResult": { "required": [ "controlActionId", "executionTime", "success" ], "type": "object", "properties": { "controlActionId": { "type": "string", "format": "uuid" }, "executionTime": { "type": "string", "format": "date-time" }, "success": { "type": "boolean" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationMessage" } } } }, "IntegrationSourceResultDto": { "required": [ "controlActionResults", "integrationSourceId" ], "type": "object", "properties": { "parentIntegrationSourceId": { "type": "string", "format": "uuid" }, "integrationSourceId": { "type": "string", "format": "uuid" }, "success": { "type": "boolean" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationMessage" } }, "startExecutionTime": { "type": "string", "format": "date-time" }, "endExecutionTime": { "type": "string", "format": "date-time" }, "controlActionResults": { "type": "array", "items": { "$ref": "#/components/schemas/ControlActionResult" } } } }, "PageAutomationDetails": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationDetails" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "AuthenticationMethodSummary": { "required": [ "authenticationType", "customerId", "id", "name", "organizationalUnitId", "usageCount" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "authenticationType": { "type": "string", "enum": [ "SAML", "OIDC", "PASSWORD" ] }, "usageCount": { "type": "integer", "format": "int32" } } }, "PageAuthenticationMethodSummary": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AuthenticationMethodSummary" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "AuthenticationMethodDetails": { "required": [ "authenticationType", "customerId", "id", "name", "organizationalUnitId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "authenticationType": { "type": "string", "enum": [ "SAML", "OIDC", "PASSWORD" ] }, "passwordDetails": { "$ref": "#/components/schemas/PasswordAuthenticationMethodDetails" }, "oidcDetails": { "$ref": "#/components/schemas/OidcAuthenticationMethodDetailsProtected" }, "samlDetails": { "$ref": "#/components/schemas/SamlAuthenticationMethodDetails" } } }, "OidcAuthenticationMethodDetailsProtected": { "required": [ "authenticationMethodId", "clientId", "issuerLocation" ], "type": "object", "properties": { "authenticationMethodId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string" }, "issuerLocation": { "type": "string" }, "groupClaim": { "type": "string" }, "domain": { "type": "string" } } }, "PasswordAuthenticationMethodDetails": { "required": [ "authenticationMethodId", "loginAttemptLimit" ], "type": "object", "properties": { "authenticationMethodId": { "type": "string", "format": "uuid" }, "loginAttemptLimit": { "type": "integer", "format": "int32" } } }, "SamlAuthenticationMethodDetails": { "required": [ "authenticationMethodId", "authnRequestsSigned", "entityId", "verificationCertificate", "webSsoUrl" ], "type": "object", "properties": { "authenticationMethodId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string" }, "webSsoUrl": { "type": "string" }, "verificationCertificate": { "type": "string" }, "groupAttribute": { "type": "string" }, "authnRequestsSigned": { "type": "boolean" }, "domain": { "type": "string" } } }, "AuditLogQueryParams": { "required": [ "id", "type" ], "type": "object", "properties": { "number": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" }, "fromDate": { "type": "string" }, "toDate": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "userIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "AuditLogDto": { "required": [ "entityType", "id", "operation", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "entityName": { "type": "string" }, "entityId": { "type": "string", "format": "uuid" }, "entityType": { "type": "string", "enum": [ "ASSESSMENT", "ASSESSOR_MODULE", "ASSESSOR_MODULE_DOCUMENT_REFERENCE", "CMMC_MATURITY_CONTROL_SCORE", "CONTROL_ACTION_SCORE", "CONTROL_ACTION_SCORE_ANNOTATION", "CONTROL_ACTION_SCORE_SUPPLEMENTAL_SCORE", "CONTROL_SCORE", "CONTROL_SCORE_JIRA", "CONTROL_SCORE_REMINDER", "CONTROL_SCORE_REMINDER_USER", "CUSTOMER", "DCMM_MATURITY_CONTROL_SCORE", "EVIDENCE", "NOTES_MODULE", "SIGNOFF_MODULE", "ASSESSMENT_CROSSWALK_START", "ASSESSMENT_CROSSWALK_COMPLETE", "CROSSWALK_TEMPLATE_START", "CROSSWALK_TEMPLATE_PUBLISH", "CROSSWALK_TEMPLATE_APPLY", "CENTRAL_ARTIFACT_LINK" ] }, "operation": { "type": "string", "enum": [ "CREATE", "UPDATE", "DELETE" ] }, "updatedAt": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "format": "uuid" }, "updatedValues": { "type": "string" }, "customerName": { "type": "string" }, "updatedByName": { "type": "string" } } }, "PageAuditLogDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "AuditLogUser": { "required": [ "displayName", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "displayName": { "type": "string" } } }, "AuditLogsConfig": { "required": [ "updatedByUsers", "updatedToUsers" ], "type": "object", "properties": { "updatedByUsers": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogUser" } }, "updatedToUsers": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogUser" } } } }, "AssetTypeViewFilters": { "type": "object", "properties": { "assetTypeName": { "type": "string" }, "assetAttributeName": { "type": "string" }, "assetTypeId": { "type": "string", "format": "uuid" } } }, "AssetAttributeAndListOptionsDto": { "required": [ "assetAttribute", "assetAttributeListOptions", "canDelete", "isFavorite", "isRequired" ], "type": "object", "properties": { "assetAttribute": { "$ref": "#/components/schemas/AssetAttribute" }, "assetAttributeListOptions": { "type": "array", "items": { "$ref": "#/components/schemas/AssetAttributeListOption" } }, "canDelete": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "isRequired": { "type": "boolean" } } }, "AssetTypeWithAttributesAndAssetGroupsDto": { "required": [ "assetAttributeAndListOptionsDto", "assetGroups", "assetType", "canDelete", "numberOfAttributes" ], "type": "object", "properties": { "assetType": { "$ref": "#/components/schemas/AssetType" }, "assetAttributeAndListOptionsDto": { "type": "array", "items": { "$ref": "#/components/schemas/AssetAttributeAndListOptionsDto" } }, "assetGroups": { "type": "array", "items": { "$ref": "#/components/schemas/AssetGroup" } }, "canDelete": { "type": "boolean" }, "numberOfAttributes": { "type": "integer", "format": "int32" } } }, "PageAssetTypeWithAttributesAndAssetGroupsDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AssetTypeWithAttributesAndAssetGroupsDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "AssetGroupFilters": { "type": "object", "properties": { "name": { "type": "string" }, "assessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "riskRegisterIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "organizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PageAssetGroup": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AssetGroup" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "AssetGroupQueryFilters": { "type": "object", "properties": { "name": { "type": "string" }, "types": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "owners": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "organizationalUnitIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "AssetGroupSummaryDto": { "required": [ "assessmentIds", "assetGroup", "assetType", "owners", "riskRegisterIds" ], "type": "object", "properties": { "assetGroup": { "$ref": "#/components/schemas/AssetGroup" }, "assetType": { "$ref": "#/components/schemas/AssetType" }, "complianceProgress": { "type": "number", "format": "double" }, "complianceScore": { "type": "number", "format": "double" }, "inherentRisk": { "type": "integer", "format": "int64" }, "residualRisk": { "type": "integer", "format": "int64" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/BasicUserDto" } }, "riskRegisterIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assessmentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/AssetAttribute" } } } }, "RiskRegisterInherentResidualRisk": { "required": [ "riskRegisterAndRiskInfoDto" ], "type": "object", "properties": { "riskRegisterAndRiskInfoDto": { "$ref": "#/components/schemas/RiskRegisterAndRiskInfoDto" }, "inherentRisk": { "type": "integer", "format": "int64" }, "residualRisk": { "type": "integer", "format": "int64" } } }, "AssetAttributeEntryDto": { "required": [ "assetAttribute", "assetAttributeListOptions", "isFavorite" ], "type": "object", "properties": { "assetAttribute": { "$ref": "#/components/schemas/AssetAttribute" }, "assetAttributeListOptions": { "type": "array", "items": { "$ref": "#/components/schemas/AssetAttributeListOption" } }, "value": { "type": "string" }, "isFavorite": { "type": "boolean" } } }, "PageAssetAttributeEntryDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AssetAttributeEntryDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "PageAssessmentSummary": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentSummary" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "AssetAttributeFilters": { "type": "object", "properties": { "attribute": { "type": "string" }, "valueType": { "type": "string" }, "value": { "type": "string" }, "assetTypeIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "AssetAttributeAndListOptionsEntry": { "required": [ "assetAttribute", "assetAttributeListOptions", "canDelete", "isRequired", "isSystem" ], "type": "object", "properties": { "assetAttribute": { "$ref": "#/components/schemas/AssetAttribute" }, "assetAttributeListOptions": { "type": "array", "items": { "$ref": "#/components/schemas/AssetAttributeListOption" } }, "canDelete": { "type": "boolean" }, "isSystem": { "type": "boolean" }, "isRequired": { "type": "boolean" } } }, "PageAssetAttributeAndListOptionsEntry": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AssetAttributeAndListOptionsEntry" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "AssetAttributeDetailsDto": { "required": [ "assetAttribute", "assetAttributeListOptions" ], "type": "object", "properties": { "assetAttribute": { "$ref": "#/components/schemas/AssetAttribute" }, "assetAttributeListOptions": { "type": "array", "items": { "$ref": "#/components/schemas/AssetAttributeListOptionDetails" } } } }, "AssetAttributeListOptionDetails": { "required": [ "assetAttributeListOption" ], "type": "object", "properties": { "assetAttributeListOption": { "$ref": "#/components/schemas/AssetAttributeListOption" }, "canDelete": { "type": "boolean" } } }, "AssessmentStatus": { "required": [ "hasControlsScored", "readOnly", "reasons" ], "type": "object", "properties": { "hasControlsScored": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string", "enum": [ "USER_ROLE", "CROSSWALK_SYNCED", "ASSESSMENT_COMPLETE" ] } }, "completedOn": { "type": "string", "format": "date-time" }, "completedBy": { "$ref": "#/components/schemas/PrincipalDto" }, "readOnly": { "type": "boolean" } } }, "CrosswalkHistoryQueryFilters": { "type": "object", "properties": { "historiesToFetch": { "type": "string", "enum": [ "FROM", "TO", "ALL" ] }, "isSynced": { "type": "boolean" } } }, "ControlAndCsfFunctionDto": { "required": [ "control", "controlScoreId", "csfFunctions", "excludeFromScore", "isRestricted" ], "type": "object", "properties": { "controlScoreId": { "type": "string", "format": "uuid" }, "isRestricted": { "type": "boolean" }, "currentCompliance": { "type": "number", "format": "float" }, "excludeFromScore": { "type": "boolean" }, "control": { "$ref": "#/components/schemas/Control" }, "csfFunctions": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "AutomationDataLakeControlActionResults": { "required": [ "messages", "policyHistories" ], "type": "object", "properties": { "lastChecked": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "SUCCESS", "PARTIAL", "ERROR" ] }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ScrapeMessageDto" } }, "policyHistories": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationDataLakePolicyHistoryDto" } } } }, "AutomationDataLakePolicyHistoryDto": { "required": [ "failingAssetCount", "history", "passingAssetCount", "policyId", "policyName", "sourceName" ], "type": "object", "properties": { "sourceName": { "type": "string" }, "policyId": { "type": "string" }, "policyName": { "type": "string" }, "policyDescription": { "type": "string" }, "currentValue": { "type": "string" }, "passingAssetCount": { "type": "integer", "format": "int32" }, "failingAssetCount": { "type": "integer", "format": "int32" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationDataLakePolicyHistoryEntryDto" } } } }, "AutomationDataLakePolicyHistoryEntryDto": { "required": [ "effectiveDate" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "oldValue": { "type": "string" }, "newValue": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" } } }, "DataLakeScrapeAssetHistoryEntryDto": { "type": "object", "properties": { "assetId": { "type": "string" }, "assetName": { "type": "string" }, "assetDescription": { "type": "string" }, "connectorId": { "type": "string", "format": "uuid" }, "result": { "type": "boolean" } } }, "AssessmentWorkflowGroup": { "required": [ "customerId", "id", "isDefault", "lastUpdated", "name", "workflowOptions" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "isDefault": { "type": "boolean" }, "lastUpdatedBy": { "type": "string", "format": "uuid" }, "lastUpdated": { "type": "string", "format": "date-time" }, "workflowOptions": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentWorkflowOption" } } } }, "AssessmentWorkflowOption": { "required": [ "assessmentWorkflowGroupId", "id", "idx", "isDone", "isInitial", "name", "roles" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "tooltip": { "type": "string" }, "isInitial": { "type": "boolean" }, "isDone": { "type": "boolean" }, "idx": { "type": "integer", "format": "int32" }, "assessmentWorkflowGroupId": { "type": "string", "format": "uuid" }, "roles": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "AssessmentSummaryConfig": { "required": [ "frameworks", "hasAssessments", "hasPublishedFrameworks", "maturityModels", "owners", "showMaturity", "tagGroups", "workflowOptions" ], "type": "object", "properties": { "tagGroups": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentTagGroupAndTagsDto" } }, "frameworks": { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkNameId" } }, "showMaturity": { "type": "boolean" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/UserNameAndId" } }, "hasPublishedFrameworks": { "type": "boolean" }, "hasAssessments": { "type": "boolean" }, "maturityModels": { "type": "array", "items": { "type": "string" } }, "workflowOptions": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentWorkflowGroup" } } } }, "FrameworkNameId": { "required": [ "id", "name", "version" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "version": { "type": "string" } } }, "UserNameAndId": { "required": [ "firstName", "id", "lastName" ], "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "id": { "type": "string", "format": "uuid" } } }, "AssessmentNameScore": { "required": [ "cyberstrongScore", "id", "identifier", "name" ], "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" }, "cyberstrongScore": { "type": "integer", "format": "int32" }, "id": { "type": "string", "format": "uuid" } } }, "CustomerAssessmentSummary": { "required": [ "assessmentCount", "cyberstrongScore", "scoredAssessmentCount", "scoredAssessments" ], "type": "object", "properties": { "assessmentCount": { "type": "integer", "format": "int32" }, "scoredAssessmentCount": { "type": "integer", "format": "int32" }, "cyberstrongScore": { "type": "integer", "format": "int32" }, "scoredAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentNameScore" } } } }, "ReportTypeData": { "required": [ "docType", "id", "pattern" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "pattern": { "type": "string" }, "docType": { "type": "string" }, "configuration": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTypeSectionData" } } } }, "ReportTypeGroups": { "required": [ "isMostCommon", "name", "reportTypeList", "useCase" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "useCase": { "type": "string" }, "isMostCommon": { "type": "boolean" }, "reportTypeList": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTypeData" } } } }, "ReportTypeSectionData": { "required": [ "params" ], "type": "object", "properties": { "text": { "type": "string" }, "params": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SSPWordConfig": { "required": [ "annotation", "assignedTo", "complianceNotes", "controlDescription", "currentScore", "dueDate", "evidence", "fullyCompliantControls", "lastUpdated", "naControlActions", "naControls", "targetScore", "totalScore", "workflowState" ], "type": "object", "properties": { "naControls": { "type": "boolean" }, "naControlActions": { "type": "boolean" }, "fullyCompliantControls": { "type": "boolean" }, "totalScore": { "type": "boolean" }, "currentScore": { "type": "boolean" }, "targetScore": { "type": "boolean" }, "workflowState": { "type": "boolean" }, "dueDate": { "type": "boolean" }, "assignedTo": { "type": "boolean" }, "lastUpdated": { "type": "boolean" }, "complianceNotes": { "type": "boolean" }, "annotation": { "type": "boolean" }, "evidence": { "type": "boolean" }, "controlDescription": { "type": "boolean" } } }, "AssessmentWorkflowDto": { "required": [ "assessmentWorkflowGroup", "frameworkCount" ], "type": "object", "properties": { "frameworkCount": { "type": "integer", "format": "int32" }, "assessmentWorkflowGroup": { "$ref": "#/components/schemas/AssessmentWorkflowGroup" } } }, "AutomatedAssessmentDefinitionDataLakePartSummary": { "required": [ "dataLakeTemplateId", "integrationSourceId", "params" ], "type": "object", "properties": { "integrationSourceId": { "type": "string", "format": "uuid" }, "integrationSourceAuthenticationId": { "type": "string", "format": "uuid" }, "dataLakeTemplateId": { "type": "string", "format": "uuid" }, "params": { "type": "object", "additionalProperties": { "type": "object" } } } }, "AutomatedAssessmentDefinitionPolicyPartSummary": { "required": [ "integrationSourceId", "params", "policyTemplateId" ], "type": "object", "properties": { "integrationSourceId": { "type": "string", "format": "uuid" }, "integrationSourceAuthenticationId": { "type": "string", "format": "uuid" }, "policyTemplateId": { "type": "string", "format": "uuid" }, "params": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AutomatedAssessmentDefinitionSummary": { "required": [ "connectorParts", "dataLakeParts", "frequency", "id", "paused", "policyParts", "vulnScanParts" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "paused": { "type": "boolean" }, "frequency": { "type": "string", "enum": [ "Daily", "Weekly", "Monthly" ] }, "dayOfWeek": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "dayOfMonth": { "type": "integer", "format": "int32" }, "connectorParts": { "type": "array", "items": { "$ref": "#/components/schemas/AutomatedAssessmentDefinitionConnectorPartDto" } }, "policyParts": { "type": "array", "items": { "$ref": "#/components/schemas/AutomatedAssessmentDefinitionPolicyPartSummary" } }, "vulnScanParts": { "type": "array", "items": { "$ref": "#/components/schemas/AutomatedAssessmentDefinitionVulnScanPartSummary" } }, "dataLakeParts": { "type": "array", "items": { "$ref": "#/components/schemas/AutomatedAssessmentDefinitionDataLakePartSummary" } } } }, "AutomatedAssessmentDefinitionVulnScanPartSummary": { "required": [ "integrationSourceId", "params", "threshold", "vulnerabilityScanTemplateId" ], "type": "object", "properties": { "integrationSourceId": { "type": "string", "format": "uuid" }, "integrationSourceAuthenticationId": { "type": "string", "format": "uuid" }, "vulnerabilityScanTemplateId": { "type": "string", "format": "uuid" }, "threshold": { "type": "integer", "format": "int32" }, "params": { "type": "object", "additionalProperties": { "type": "object" } } } }, "CentralArtifactFilters": { "required": [ "evidencesOnly" ], "type": "object", "properties": { "name": { "type": "string" }, "controlScoreId": { "type": "string", "format": "uuid" }, "removeLinksForControlScoreId": { "type": "string", "format": "uuid" }, "evidencesOnly": { "type": "boolean" }, "createdAtGreaterOrEqual": { "type": "string", "format": "date-time" }, "updatedAtGreaterOrEqual": { "type": "string", "format": "date-time" }, "linkedBeforeDate": { "type": "string", "format": "date-time" } } }, "PageArtifactAndLinksDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ArtifactAndLinksDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "ApiKeyResponse": { "required": [ "apiKey", "createdAt", "createdBy", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "$ref": "#/components/schemas/BasicUserDto" }, "apiKey": { "type": "string" }, "lastUse": { "type": "string", "format": "date-time" } } }, "AdvisenSecondaryIndustry": { "required": [ "advisenSectorId", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "advisenSectorId": { "type": "string", "format": "uuid" } } }, "AdvisenSectorDto": { "required": [ "advisenSecondaryIndustries", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "advisenSecondaryIndustries": { "type": "array", "items": { "$ref": "#/components/schemas/AdvisenSecondaryIndustry" } } } }, "RelatedControlFilterParams": { "type": "object", "properties": { "controlName": { "type": "string" }, "riskCount": { "type": "integer", "format": "int32" }, "riskName": { "type": "string" } } }, "PageRelatedSp80053ControlAndRisks": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedSp80053ControlAndRisks" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "RelatedSp80053ControlAndRisks": { "required": [ "riskNames", "sp80053Control" ], "type": "object", "properties": { "sp80053Control": { "$ref": "#/components/schemas/Sp80053Control" }, "riskNames": { "type": "array", "items": { "type": "string" } } } }, "RelatedControlsConfig": { "required": [ "riskCounts", "riskNames" ], "type": "object", "properties": { "riskCounts": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "riskNames": { "type": "array", "items": { "type": "string" } } } }, "AdvisenLossCountsQueryParams": { "type": "object", "properties": { "sectorId": { "type": "string", "format": "uuid" }, "advisenSecondaryIndustryId": { "type": "string", "format": "uuid" }, "revenue": { "type": "integer", "format": "int64" }, "employeeCount": { "type": "integer", "format": "int64" }, "filterZeroLossMagnitude": { "type": "boolean" }, "filterUnknownOther": { "type": "boolean" }, "filterZeroLikelihood": { "type": "boolean" } } }, "AdvisenLossCounts": { "required": [ "attackVectors" ], "type": "object", "properties": { "employeeLowerBound": { "type": "number" }, "employeeUpperBound": { "type": "number" }, "numYears": { "type": "integer", "format": "int32" }, "revenueLowerBound": { "type": "number" }, "revenueUpperBound": { "type": "number" }, "attackVectors": { "type": "array", "items": { "$ref": "#/components/schemas/AttackVectorLossCount" } }, "errorCode": { "type": "string" } } }, "ControlWithScoresControlScoreV1": { "required": [ "assessmentId", "assessmentIdentifier", "assessmentName", "controlFamily", "controlId", "controlLabel", "controlScoreId", "excludeFromScore", "frameworkId", "isRestricted", "isScored" ], "type": "object", "properties": { "controlId": { "type": "string", "format": "uuid" }, "controlFamily": { "type": "string" }, "controlLabel": { "type": "string" }, "parentControlLabel": { "type": "string" }, "auxiliaryControlLabel": { "type": "string" }, "assessmentId": { "type": "string", "format": "uuid" }, "assessmentIdentifier": { "type": "string" }, "assessmentName": { "type": "string" }, "score": { "type": "number" }, "normalizedScore": { "type": "number" }, "scoreLabel": { "type": "string" }, "controlScoreId": { "type": "string", "format": "uuid" }, "excludeFromScore": { "type": "boolean" }, "frameworkId": { "type": "string", "format": "uuid" }, "isScored": { "type": "boolean" }, "isRestricted": { "type": "boolean" } } }, "ControlWithScoresV1": { "required": [ "controlFamily", "controlId", "controlLabel", "controlScores" ], "type": "object", "properties": { "controlId": { "type": "string", "format": "uuid" }, "controlFamily": { "type": "string" }, "controlLabel": { "type": "string" }, "parentControlLabel": { "type": "string" }, "auxiliaryControlLabel": { "type": "string" }, "controlScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWithScoresControlScoreV1" } }, "score": { "type": "number" }, "normalizedScore": { "type": "number" } } }, "CyberInsightRiskResponseV1": { "required": [ "annualizedLossExpectancyMax", "annualizedLossExpectancyMin", "annualizedLossExpectancyMostLikely", "associatedControlScores", "associatedControls", "createdAt", "createdBy", "id", "name", "owners", "riskDashboardId", "riskDashboardName", "riskDashboardType", "updatedBy" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RiskResponseV1" }, { "type": "object", "properties": { "treatmentPlanOptionId": { "type": "string", "format": "uuid" }, "treatmentPlanDueDate": { "type": "string", "format": "date-time" }, "treatmentPlanNote": { "type": "string" }, "overallInherentLikelihoodLevelValue": { "type": "number" }, "overallInherentLikelihoodLevelVariance": { "type": "number" }, "overallInherentLikelihoodLevelConfidence": { "type": "number" }, "overallResidualLikelihoodLevelValue": { "type": "number" }, "overallResidualLikelihoodLevelVariance": { "type": "number" }, "overallResidualLikelihoodLevelConfidence": { "type": "number" }, "overallInherentImpactLevelValue": { "type": "number" }, "overallInherentImpactLevelVariance": { "type": "number" }, "overallInherentImpactLevelConfidence": { "type": "number" }, "overallResidualImpactLevelValue": { "type": "number" }, "overallResidualImpactLevelVariance": { "type": "number" }, "overallResidualImpactLevelConfidence": { "type": "number" }, "overallInherentRiskLevelValue": { "type": "number" }, "overallInherentRiskLevelVariance": { "type": "number" }, "overallInherentRiskLevelConfidence": { "type": "number" }, "overallResidualRiskLevelValue": { "type": "number" }, "overallResidualRiskLevelVariance": { "type": "number" }, "overallResidualRiskLevelConfidence": { "type": "number" }, "attackSurface": { "type": "number" }, "threatActorCapacity": { "type": "number" }, "threatLevel": { "type": "number" }, "priorAttackProbability": { "type": "number" }, "attackProbability": { "type": "number" }, "attackMotivators": { "type": "number" }, "exploitability": { "type": "number" }, "vulnerability": { "type": "number" }, "directImpact": { "type": "number" }, "indirectImpact": { "type": "number" }, "targetOverallInherentLikelihoodLevelValue": { "type": "number" }, "targetOverallInherentLikelihoodLevelVariance": { "type": "number" }, "targetOverallInherentLikelihoodLevelConfidence": { "type": "number" }, "targetOverallResidualLikelihoodLevelValue": { "type": "number" }, "targetOverallResidualLikelihoodLevelVariance": { "type": "number" }, "targetOverallResidualLikelihoodLevelConfidence": { "type": "number" }, "targetOverallInherentImpactLevelValue": { "type": "number" }, "targetOverallInherentImpactLevelVariance": { "type": "number" }, "targetOverallInherentImpactLevelConfidence": { "type": "number" }, "targetOverallResidualImpactLevelValue": { "type": "number" }, "targetOverallResidualImpactLevelVariance": { "type": "number" }, "targetOverallResidualImpactLevelConfidence": { "type": "number" }, "targetOverallInherentRiskLevelValue": { "type": "number" }, "targetOverallInherentRiskLevelVariance": { "type": "number" }, "targetOverallInherentRiskLevelConfidence": { "type": "number" }, "targetOverallResidualRiskLevelValue": { "type": "number" }, "targetOverallResidualRiskLevelVariance": { "type": "number" }, "targetOverallResidualRiskLevelConfidence": { "type": "number" }, "targetAttackSurface": { "type": "number" }, "targetThreatActorCapacity": { "type": "number" }, "targetThreatLevel": { "type": "number" }, "targetPriorAttackProbability": { "type": "number" }, "targetAttackProbability": { "type": "number" }, "targetAttackMotivators": { "type": "number" }, "targetExploitability": { "type": "number" }, "targetVulnerability": { "type": "number" }, "targetDirectImpact": { "type": "number" }, "targetIndirectImpact": { "type": "number" }, "ttpThreatCoverageValue": { "type": "number" }, "ttpThreatCoverageVariance": { "type": "number" }, "ttpThreatCoverageConfidence": { "type": "number" }, "ttpControlCoverageValue": { "type": "number" }, "ttpControlCoverageVariance": { "type": "number" }, "ttpControlCoverageConfidence": { "type": "number" }, "ttpControlEffectivenessValue": { "type": "number" }, "ttpControlEffectivenessVariance": { "type": "number" }, "ttpControlEffectivenessConfidence": { "type": "number" }, "annualizedLossExpectancyMin": { "type": "integer", "format": "int64" }, "annualizedLossExpectancyMax": { "type": "integer", "format": "int64" }, "annualizedLossExpectancyMostLikely": { "type": "integer", "format": "int64" } } } ] }, "FairRiskResponseV1": { "required": [ "associatedControlIds", "associatedControlScoreIds", "associatedControlScores", "associatedControls", "createdAt", "createdBy", "id", "lossCurve", "lossFrequencyMax", "lossFrequencyMin", "lossFrequencyMostLikely", "lossMagnitudeMax", "lossMagnitudeMin", "lossMagnitudeMostLikely", "maxLoss", "meanLoss", "minLoss", "name", "ninetyPercentile", "owners", "riskDashboardId", "riskDashboardName", "riskDashboardType", "riskDistributionCurve", "tenthPercentile", "updatedBy" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RiskResponseV1" }, { "type": "object", "properties": { "lossFrequencyMin": { "type": "number", "format": "double" }, "lossFrequencyMax": { "type": "number", "format": "double" }, "lossFrequencyMostLikely": { "type": "number", "format": "double" }, "lossMagnitudeMin": { "type": "integer", "format": "int64" }, "lossMagnitudeMax": { "type": "integer", "format": "int64" }, "lossMagnitudeMostLikely": { "type": "integer", "format": "int64" }, "minLoss": { "type": "number" }, "maxLoss": { "type": "number" }, "meanLoss": { "type": "number" }, "ninetyPercentile": { "type": "number" }, "tenthPercentile": { "type": "number" }, "lossFrequencyDescription": { "type": "string" }, "lossMagnitudeDescription": { "type": "string" }, "associatedControlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "associatedControlScoreIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "lossCurve": { "type": "array", "items": { "$ref": "#/components/schemas/LossCurveValue" } }, "riskDistributionCurve": { "type": "array", "items": { "$ref": "#/components/schemas/RiskDistributionValue" } } } } ] }, "LossCurveValue": { "required": [ "chance", "lossGreaterThan" ], "type": "object", "properties": { "chance": { "type": "number" }, "lossGreaterThan": { "type": "number" } } }, "NistRiskResponseV1": { "required": [ "associatedControlScores", "associatedControls", "createdAt", "createdBy", "id", "impactId", "impactLabel", "impactValue", "likelihoodId", "likelihoodLabel", "likelihoodValue", "name", "owners", "riskDashboardId", "riskDashboardName", "riskDashboardType", "riskMethod", "riskModelId", "riskModelName", "singleLossExpectancyMax", "singleLossExpectancyMaxFormatted", "singleLossExpectancyMin", "singleLossExpectancyMinFormatted", "singleLossExpectancyMostLikely", "singleLossExpectancyMostLikelyFormatted", "threatEventFrequencyMax", "threatEventFrequencyMin", "threatEventFrequencyMostLikely", "updatedBy" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/RiskResponseV1" }, { "type": "object", "properties": { "riskMethod": { "type": "string", "enum": [ "FAIR", "NIST", "BAH" ] }, "riskModelId": { "type": "string", "format": "uuid" }, "riskModelName": { "type": "string" }, "likelihoodId": { "type": "string", "format": "uuid" }, "likelihoodLabel": { "type": "string" }, "likelihoodValue": { "type": "number" }, "likelihoodDetails": { "type": "string" }, "impactId": { "type": "string", "format": "uuid" }, "impactLabel": { "type": "string" }, "impactValue": { "type": "number" }, "impactDetails": { "type": "string" }, "threatEventFrequencyMin": { "type": "number" }, "threatEventFrequencyMax": { "type": "number" }, "threatEventFrequencyMostLikely": { "type": "number" }, "singleLossExpectancyMin": { "type": "number" }, "singleLossExpectancyMinFormatted": { "type": "string" }, "singleLossExpectancyMax": { "type": "number" }, "singleLossExpectancyMaxFormatted": { "type": "string" }, "singleLossExpectancyMostLikely": { "type": "number" }, "singleLossExpectancyMostLikelyFormatted": { "type": "string" }, "trend": { "type": "string", "enum": [ "UP", "NO_CHANGE", "DOWN" ] }, "target": { "$ref": "#/components/schemas/NistRiskTargetV1" } } } ] }, "NistRiskTargetV1": { "required": [ "singleLossExpectancyEnabled", "targetDate", "threatEventFrequencyMax", "threatEventFrequencyMin", "threatEventFrequencyMostLikely" ], "type": "object", "properties": { "likelihoodId": { "type": "string", "format": "uuid" }, "likelihoodLabel": { "type": "string" }, "likelihoodValue": { "type": "number" }, "threatEventFrequencyMin": { "type": "number" }, "threatEventFrequencyMax": { "type": "number" }, "threatEventFrequencyMostLikely": { "type": "number" }, "targetDate": { "type": "string", "format": "date-time" }, "singleLossExpectancyEnabled": { "type": "boolean" }, "singleLossExpectancyMin": { "type": "number" }, "singleLossExpectancyMinFormatted": { "type": "string" }, "singleLossExpectancyMax": { "type": "number" }, "singleLossExpectancyMaxFormatted": { "type": "string" }, "singleLossExpectancyMostLikely": { "type": "number" }, "singleLossExpectancyMostLikelyFormatted": { "type": "string" } } }, "PageRiskResponseV1": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CyberInsightRiskResponseV1" }, { "$ref": "#/components/schemas/FairRiskResponseV1" }, { "$ref": "#/components/schemas/NistRiskResponseV1" } ] } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "PrincipalResponseV1": { "required": [ "displayName", "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "displayName": { "type": "string" }, "type": { "type": "string", "enum": [ "USER", "API", "SYSTEM" ] }, "email": { "type": "string" } } }, "RiskDistributionValue": { "required": [ "count", "loss" ], "type": "object", "properties": { "count": { "type": "number" }, "loss": { "type": "number" } } }, "RiskResponseV1": { "required": [ "associatedControlScores", "associatedControls", "createdAt", "createdBy", "id", "name", "owners", "riskDashboardId", "riskDashboardName", "riskDashboardType", "type", "updatedBy" ], "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "createdBy": { "$ref": "#/components/schemas/PrincipalResponseV1" }, "externalId": { "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/PrincipalResponseV1" }, "updatedAt": { "type": "string", "format": "date-time" }, "assessmentName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "assessmentId": { "type": "string", "format": "uuid" }, "riskDashboardId": { "type": "string", "format": "uuid" }, "associatedControls": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWithScoresV1" } }, "associatedControlScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlWithScoresControlScoreV1" } }, "riskDashboardName": { "type": "string" }, "riskDashboardType": { "type": "string", "enum": [ "FAIR", "NIST", "CYBERINSIGHTS" ] }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/UserResponseV1" } }, "type": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "UserResponseV1": { "required": [ "email", "firstName", "id", "lastName" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" } } }, "ControlScoreActionAnnotationPublicDtoV1": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "annotation": { "type": "string" }, "annotationStr": { "type": "string" } } }, "ControlScoreActionDtoV1": { "required": [ "controlActionContent", "controlActionId", "disabled", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "controlActionId": { "type": "string", "format": "uuid" }, "controlActionContent": { "type": "string" }, "controlActionIdx": { "type": "integer", "format": "int32" }, "controlActionLevel": { "type": "integer", "format": "int32" }, "disabled": { "type": "boolean" }, "currentScore": { "$ref": "#/components/schemas/ControlScoreActionScoreDtoV1" }, "targetScore": { "$ref": "#/components/schemas/ControlScoreActionScoreDtoV1" }, "annotation": { "$ref": "#/components/schemas/ControlScoreActionAnnotationPublicDtoV1" } } }, "ControlScoreActionScoreDtoV1": { "required": [ "id", "label", "value" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "value": { "type": "number", "format": "float" }, "label": { "type": "string" } } }, "ControlScoreNotePublicDtoV1": { "type": "object", "properties": { "notes": { "type": "string" }, "notesStr": { "type": "string" }, "lastUpdatedAt": { "type": "string", "format": "date-time" } } }, "ControlScorePublicDtoV1": { "required": [ "assessmentId", "businessImpact", "collaborators", "controlDescription", "controlFamily", "controlId", "controlLabel", "controlScoreActions", "createdAt", "disabled", "id", "parentControlLabel", "threatType" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "assessmentId": { "type": "string", "format": "uuid" }, "controlId": { "type": "string", "format": "uuid" }, "controlFamily": { "type": "string" }, "controlLabel": { "type": "string" }, "parentControlLabel": { "type": "string" }, "auxiliaryControlLabel": { "type": "string" }, "controlDescription": { "type": "string" }, "controlLevel": { "type": "integer", "format": "int32" }, "currentScore": { "type": "number", "format": "float" }, "assignedTo": { "$ref": "#/components/schemas/UserResponseV1" }, "updatedBy": { "$ref": "#/components/schemas/PrincipalResponseV1" }, "riskImpact": { "type": "integer", "format": "int32" }, "riskLikelihood": { "type": "integer", "format": "int32" }, "targetScore": { "type": "number", "format": "float" }, "dataProtection": { "type": "string", "enum": [ "CONFIDENTIALITY", "INTEGRITY", "AVAILABILITY" ] }, "threatType": { "type": "array", "items": { "type": "string", "enum": [ "ADVERSARIAL", "ACCIDENTAL", "STRUCTURAL", "ENVIRONMENTAL" ] } }, "businessImpact": { "type": "array", "items": { "type": "string", "enum": [ "REGULATORY_AND_LEGAL", "REPUTATIONAL", "FINANCIAL", "OPERATIONAL" ] } }, "dueDate": { "type": "string", "format": "date-time" }, "collaborators": { "type": "array", "items": { "$ref": "#/components/schemas/UserResponseV1" } }, "financialImpactMin": { "type": "integer", "format": "int32" }, "financialImpactMax": { "type": "integer", "format": "int32" }, "financialImpactMostLikely": { "type": "integer", "format": "int32" }, "completionCostValue": { "type": "integer", "format": "int32" }, "maturityScore": { "type": "number", "format": "double" }, "normalizedCurrentCompliance": { "type": "number", "format": "double" }, "normalizedTargetScore": { "type": "number", "format": "double" }, "workflow": { "$ref": "#/components/schemas/ControlWorkflowPublicDtoV1" }, "disabled": { "type": "boolean" }, "note": { "$ref": "#/components/schemas/ControlScoreNotePublicDtoV1" }, "controlScoreActions": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScoreActionDtoV1" } } } }, "ControlWorkflowPublicDtoV1": { "required": [ "id", "isDone", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "isDone": { "type": "boolean" } } }, "PageRiskDashboardResponseV1": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/RiskDashboardResponseV1" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "RiskDashboardResponseV1": { "required": [ "id", "name", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "FAIR", "NIST", "CYBERINSIGHTS" ] }, "assessmentId": { "type": "string", "format": "uuid" } } }, "FrameworkPublicDtoV1": { "required": [ "assessmentScoreMethod", "controlScoreMethod", "csfWeighted", "cybersecurityFrameworkId", "id", "name", "scoreModelId", "status", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "version": { "type": "string" }, "type": { "type": "string", "enum": [ "Regulatory", "Binary" ] }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "Draft", "Published", "Disabled" ] }, "cybersecurityFrameworkId": { "type": "string", "format": "uuid" }, "csfWeighted": { "type": "boolean" }, "scoreModelId": { "type": "string", "format": "uuid" }, "controlScoreMethod": { "type": "string", "enum": [ "BINARY", "LEVEL", "REGULATORY", "CMMC_2" ] }, "assessmentScoreMethod": { "type": "string", "enum": [ "DFARS_171A", "RAW_CONTROL_FAMILY", "RAW_LEVELED_CONTROL_FAMILY", "RAW_PARENT_CONTROL_LABEL", "RAW", "CONTROL_FAMILY", "PARENT_CONTROL_LABEL", "CYBERSTRONG", "CMMC_2" ] }, "controlWorkflowOptionSetId": { "type": "string", "format": "uuid" } } }, "ScoreModelPublicDtoV1": { "required": [ "id", "name", "values" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreModelValuePublicDtoV1" } } } }, "ScoreModelValuePublicDtoV1": { "required": [ "id", "label", "order", "value" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "value": { "type": "number" }, "order": { "type": "integer", "format": "int32" }, "description": { "type": "string" } } }, "FrameworkMetadataFieldPublicDtoV1": { "required": [ "id", "label", "required", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "type": "string" }, "hint": { "type": "string" }, "type": { "type": "string", "enum": [ "TEXT" ] }, "required": { "type": "boolean" } } }, "FrameworkMetadataFieldResponseV1": { "required": [ "fields" ], "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkMetadataFieldPublicDtoV1" } } } }, "ControlActionPublicDtoV1": { "required": [ "content", "id" ], "type": "object", "properties": { "content": { "type": "string" }, "level": { "type": "integer", "format": "int32" }, "id": { "type": "string", "format": "uuid" } } }, "ControlPublicDtoV1": { "required": [ "controlFamily", "controlLabel", "description", "id", "parentControlLabel" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "controlFamily": { "type": "string" }, "controlLabel": { "type": "string" }, "parentControlLabel": { "type": "string" }, "auxiliaryControlLabel": { "type": "string" }, "description": { "type": "string" }, "supplementalGuidance": { "type": "string" }, "evidenceRequired": { "type": "string" }, "remediationSteps": { "type": "string" }, "complianceDescription": { "type": "string" }, "level": { "type": "integer", "format": "int32" }, "controlActions": { "type": "array", "items": { "$ref": "#/components/schemas/ControlActionPublicDtoV1" } } } }, "PageControlPublicDtoV1": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ControlPublicDtoV1" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "EvidencePublicDtoV1": { "required": [ "assessmentId", "controlId", "controlScoreId", "id", "location", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "$ref": "#/components/schemas/UserResponseV1" }, "name": { "type": "string" }, "location": { "type": "string" }, "controlScoreId": { "type": "string", "format": "uuid" }, "assessmentId": { "type": "string", "format": "uuid" }, "controlId": { "type": "string", "format": "uuid" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "$ref": "#/components/schemas/UserResponseV1" } } }, "PageEvidencePublicDtoV1": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/EvidencePublicDtoV1" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "AssetGroupResponseV1": { "required": [ "attributes", "id", "name", "organizationalUnitId", "owners", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "organizationalUnitId": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/AssetType" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/PrincipalResponseV1" } }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/AssetAttribute" } } } }, "PageAssetGroupResponseV1": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AssetGroupResponseV1" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "PageControlScorePublicDtoV1": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScorePublicDtoV1" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "AssessmentPublicDtoV1": { "required": [ "controlScores", "createdAt", "frameworkId", "frameworkName", "frameworkType", "id", "identifier", "name", "percentComplete" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "frameworkId": { "type": "string", "format": "uuid" }, "frameworkName": { "type": "string" }, "frameworkType": { "type": "string", "enum": [ "Regulatory", "Binary" ] }, "frameworkVersion": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "score": { "type": "number" }, "owner": { "$ref": "#/components/schemas/UserResponseV1" }, "percentComplete": { "type": "integer", "format": "int32" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "identifier": { "type": "string" }, "targetScore": { "type": "number" }, "controlScores": { "type": "array", "items": { "$ref": "#/components/schemas/ControlScorePublicDtoV1" } } } }, "PageAssessmentPublicDtoV1": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentPublicDtoV1" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "AssessmentCsfScoresResponseV1": { "required": [ "functions" ], "type": "object", "properties": { "functions": { "type": "array", "items": { "$ref": "#/components/schemas/CsfFunctionResponseV1" } } } }, "CsfCategoryResponseV1": { "required": [ "current", "label", "subcategories", "target" ], "type": "object", "properties": { "label": { "type": "string" }, "uniqueIdentifier": { "type": "string" }, "current": { "type": "number" }, "target": { "type": "number" }, "targetControlsInCalculation": { "type": "integer", "format": "int32" }, "currentControlsInCalculation": { "type": "integer", "format": "int32" }, "subcategories": { "type": "array", "items": { "$ref": "#/components/schemas/CsfSubcategoryResponseV1" } } } }, "CsfFunctionResponseV1": { "required": [ "categories", "current", "label", "target" ], "type": "object", "properties": { "label": { "type": "string" }, "current": { "type": "number" }, "target": { "type": "number" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CsfCategoryResponseV1" } } } }, "CsfSubcategoryResponseV1": { "required": [ "current", "label", "target" ], "type": "object", "properties": { "label": { "type": "string" }, "current": { "type": "number" }, "target": { "type": "number" } } }, "AssessmentMetadataFieldValuePublicDtoV1": { "required": [ "frameworkMetadataFieldId", "id", "label" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "value": { "type": "string" }, "label": { "type": "string" }, "frameworkMetadataFieldId": { "type": "string", "format": "uuid" } } }, "AssessmentMetadataFieldsResponseV1": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentMetadataFieldValuePublicDtoV1" } } } }, "PageVulnerabilityScanTemplate": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/VulnerabilityScanTemplate" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "ScoreGuidanceSetDto": { "required": [ "description", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" } } }, "ScoreGuidanceSet": { "required": [ "description", "id", "scoreGuidance" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "scoreGuidance": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreGuidance" } } } }, "ScheduledJobHistory": { "required": [ "id", "scheduledJobId", "startDate", "status" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "scheduledJobId": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "finishDate": { "type": "string", "format": "date-time" }, "details": { "type": "string" }, "instanceId": { "type": "string" } } }, "ScheduledJobResponse": { "required": [ "description", "enabled", "jobType", "name", "schedule" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "jobType": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "schedule": { "type": "string" }, "scheduledJobHistory": { "$ref": "#/components/schemas/ScheduledJobHistory" } } }, "AssessmentModule": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "AdminFrameworkSummary": { "required": [ "assessmentScoreMethod", "controlIds", "controlScoreMethod", "createdOn", "customScoreModelId", "cybersecurityFrameworkId", "id", "name", "revision", "status", "type" ], "type": "object", "properties": { "name": { "type": "string" }, "revision": { "type": "integer", "format": "int32" }, "customerName": { "type": "string" }, "customerId": { "type": "string", "format": "uuid" }, "customScoreModelId": { "type": "string", "format": "uuid" }, "controlScoreMethod": { "type": "string" }, "assessmentScoreMethod": { "type": "string" }, "type": { "type": "string", "enum": [ "Regulatory", "Binary" ] }, "controlIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "createdOn": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "Draft", "Published", "Disabled" ] }, "description": { "type": "string" }, "version": { "type": "string" }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/FrameworkModule" } }, "cybersecurityFrameworkId": { "type": "string", "format": "uuid" }, "supplementalScoreModelId": { "type": "string", "format": "uuid" } } }, "ScoreGuidanceSummaryDto": { "required": [ "controlAction" ], "type": "object", "properties": { "controlAction": { "$ref": "#/components/schemas/ControlAction" }, "scoreGuidanceSetDto": { "$ref": "#/components/schemas/ScoreGuidanceSetDto" } } }, "FrameworkAdminConfig": { "required": [ "assessmentCharts", "assessmentScoreMethodOptions", "controlScoreMethodOptions", "cybersecurityFrameworks", "models", "supplementalScoreModels" ], "type": "object", "properties": { "assessmentScoreMethodOptions": { "type": "array", "items": { "type": "string", "enum": [ "DFARS_171A", "RAW_CONTROL_FAMILY", "RAW_LEVELED_CONTROL_FAMILY", "RAW_PARENT_CONTROL_LABEL", "RAW", "CONTROL_FAMILY", "PARENT_CONTROL_LABEL", "CYBERSTRONG", "CMMC_2" ] } }, "controlScoreMethodOptions": { "type": "array", "items": { "type": "string", "enum": [ "BINARY", "LEVEL", "REGULATORY", "CMMC_2" ] } }, "models": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreModel" } }, "cybersecurityFrameworks": { "type": "array", "items": { "$ref": "#/components/schemas/CybersecurityFramework" } }, "supplementalScoreModels": { "type": "array", "items": { "$ref": "#/components/schemas/SupplementalScoreModel" } }, "assessmentCharts": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentChart" } } } }, "CustomerOverallStats": { "required": [ "customersWithoutControlUpdatesInLast14Days", "customersWithoutLoginsInLast14Days" ], "type": "object", "properties": { "customersWithoutLoginsInLast14Days": { "type": "integer", "format": "int32" }, "customersWithoutControlUpdatesInLast14Days": { "type": "integer", "format": "int32" } } }, "CustomerListQueryParams": { "type": "object", "properties": { "name": { "type": "string" }, "productPackages": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "status": { "type": "boolean" }, "customersWithoutLoginsInLast14Days": { "type": "boolean" }, "customersWithoutControlUpdatesInLast14Days": { "type": "boolean" } } }, "CustomerStat": { "required": [ "customerId" ], "type": "object", "properties": { "lastLogin": { "type": "string", "format": "date-time" }, "daysFromLastLogin": { "type": "integer", "format": "int32" }, "lastControlUpdate": { "type": "string", "format": "date-time" }, "daysFromLastControlUpdate": { "type": "integer", "format": "int32" }, "customerId": { "type": "string", "format": "uuid" } } }, "CustomerWithStats": { "required": [ "customer", "stat" ], "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/Customer" }, "stat": { "$ref": "#/components/schemas/CustomerStat" } } }, "ProductFeatureDto": { "required": [ "displayColumn", "id", "isAddOn", "name", "packageId", "requires" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "packageId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "requires": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "isAddOn": { "type": "boolean" }, "displayColumn": { "type": "integer", "format": "int32" } } }, "ProductPackageDto": { "required": [ "displayOrder", "id", "name", "productPackageGroupDtos" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "displayOrder": { "type": "integer", "format": "int32" }, "productPackageGroupDtos": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPackageGroupDto" } } } }, "ProductPackageGroupDto": { "required": [ "productFeatureDtos" ], "type": "object", "properties": { "productFeatureDtos": { "type": "array", "items": { "$ref": "#/components/schemas/ProductFeatureDto" } } } }, "PageCrosswalkMappingFullDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/CrosswalkMappingFullDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "PageControlDto": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ControlDto" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "AuditLogUserCount": { "required": [ "count", "userName" ], "type": "object", "properties": { "userName": { "type": "string" }, "count": { "type": "integer", "format": "int32" } } }, "PageAuditLogUserCount": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogUserCount" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } }, "AuditLogEventCount": { "required": [ "count", "entityType" ], "type": "object", "properties": { "entityType": { "type": "string", "enum": [ "ASSESSMENT", "ASSESSOR_MODULE", "ASSESSOR_MODULE_DOCUMENT_REFERENCE", "CMMC_MATURITY_CONTROL_SCORE", "CONTROL_ACTION_SCORE", "CONTROL_ACTION_SCORE_ANNOTATION", "CONTROL_ACTION_SCORE_SUPPLEMENTAL_SCORE", "CONTROL_SCORE", "CONTROL_SCORE_JIRA", "CONTROL_SCORE_REMINDER", "CONTROL_SCORE_REMINDER_USER", "CUSTOMER", "DCMM_MATURITY_CONTROL_SCORE", "EVIDENCE", "NOTES_MODULE", "SIGNOFF_MODULE", "ASSESSMENT_CROSSWALK_START", "ASSESSMENT_CROSSWALK_COMPLETE", "CROSSWALK_TEMPLATE_START", "CROSSWALK_TEMPLATE_PUBLISH", "CROSSWALK_TEMPLATE_APPLY", "CENTRAL_ARTIFACT_LINK" ] }, "count": { "type": "integer", "format": "int32" } } }, "PageAuditLogEventCount": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogEventCount" } }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "empty": { "type": "boolean" } } } } } }