{ "openapi": "3.0.1", "info": { "title": "Mend API", "description": "Mend's enhanced SCA API enables automation of workflows in a REST compliant format. The API features:\n+ Access for any user with Mend credentials, via a user key available in the user's profile page in the Mend App.\n+ Improved security with a JWT token per organization, which expires every 10 minutes.\n+ Added scalability with support for pagination, filtering and sorting search results.\n+ Broader functionality available programmatically.\n+ New standard API documentation for easy navigation and search.\n\n**Note:** To help you get started with the Mend SCA API 2.0, we recommend reviewing our onboarding guide -> [Getting Started with Mend SCA API 2.0](https://docs.mend.io/legacy-sca/latest/getting-started-with-mend-sca-api-2-0).\nThis resource covers initial setup, authentication instructions, and helpful tips to help you successfully begin working with the Mend SCA API 2.0. If you have a dedicated instance of Mend, contact your Mend representative to access this API on your instance.\n", "version": "2.0" }, "servers": [ { "url": "https://api-saas.mend.io", "description": "Generated server url" } ], "security": [ { "bearer-key": [] } ], "paths": { "/api/v2.0/projects/{projectToken}/reassign/{productToken}": { "put": { "tags": [ "Entities - Project" ], "summary": "Reassign Project", "description": "Reassigns a project from one product to another.", "operationId": "changeAssignment", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } }, { "name": "productToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/policies/{policyUuid}": { "get": { "tags": [ "Policies - Project" ], "summary": "Get Project Policy", "description": "Returns a single policy in a given project", "operationId": "getContextPolicy", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } }, { "name": "policyUuid", "in": "path", "description": "Policy UUID (by running Policies - Organization and run Get Organization Policies, or the equivalent for Product or Project.)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "put": { "tags": [ "Policies - Project" ], "summary": "Update Project Policy", "description": "Updates a policy for a given project", "operationId": "updatePolicy", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } }, { "name": "policyUuid", "in": "path", "description": "Policy UUID (by running Policies - Organization and run Get Organization Policies, or the equivalent for Product or Project.)", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "delete": { "tags": [ "Policies - Project" ], "summary": "Delete Project Policy", "description": "Deletes a policy for a given project", "operationId": "deletePolicy", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } }, { "name": "policyUuid", "in": "path", "description": "Policy UUID (by running Policies - Organization and run Get Organization Policies, or the equivalent for Product or Project.)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/policies/priority": { "put": { "tags": [ "Policies - Project" ], "summary": "Update Project Policy Priorities", "description": "Updates the priority of policies in a given project. Policies are numbered and then evaluated sequentially. The request body should contain a list of policy UUIDs in the desired order, starting from highest priority. The service returns a list or ordered policies.", "operationId": "updatePriorities", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePrioritiesRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCollectionPolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/libraries/{libraryUuid}/customAttributes/{attributeUuid}/value": { "put": { "tags": [ "CustomAttribute - Project" ], "summary": "Set Custom Attribute", "description": "Edits the value of a custom attribute for a specified library, attribute, and context.", "operationId": "setCustomAttributeValue", "parameters": [ { "name": "projectToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } }, { "name": "attributeUuid", "in": "path", "description": "Custom Attribute UUID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAttributeValueDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/alerts/security/{alertUuid}": { "put": { "tags": [ "Alerts - Project" ], "summary": "Update Security Alert", "description": "Changes a given security alert's status and comments", "operationId": "updateSecurityAlert", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } }, { "name": "alertUuid", "in": "path", "description": "Alert UUID (by running the appropriate Get in Alerts - Project).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRiskRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/alerts/security/library/{libraryUuid}": { "put": { "tags": [ "Alerts - Project" ], "summary": "Update Library Security Alert", "description": "Updates the status of a library security alert", "operationId": "updateLibrarySecurityAlert", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRiskRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseBoolean" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/alerts/legal/{alertUuid}": { "put": { "tags": [ "Alerts - Project" ], "summary": "Update Legal And Compliance Alert", "description": "Updates the status of the legal and compliance alerts for a given project", "operationId": "updateLegalAndComplianceAlert", "parameters": [ { "name": "projectToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "alertUuid", "in": "path", "description": "Alert UUID (by running the appropriate Get in Alerts - Project).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRiskRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}": { "get": { "tags": [ "Entities - Project" ], "summary": "Get Project", "description": "Returns the project identified by its token", "operationId": "getEntity", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseProjectDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "put": { "tags": [ "Entities - Project" ], "summary": "Rename Project", "description": "Renames the project identified by its token.", "operationId": "updateProject", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextEntityRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseProjectDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "delete": { "tags": [ "Entities - Project" ], "summary": "Remove Project", "description": "Deletes the project identified by its token", "operationId": "removeEntity", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectIdentifier}/libraries/{libraryUuid}/settings/attributionReport": { "put": { "tags": [ "project-attribution-report-controller" ], "summary": "Update attribution report library settings", "description": "Update library settings to be reflected in the attribution report", "operationId": "updateAttributionReportLibrarySettings", "parameters": [ { "name": "projectIdentifier", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributionReportLibrarySettingRuleDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/policies/{policyUuid}": { "get": { "tags": [ "Policies - Product" ], "summary": "Get Product Policy", "description": "Returns a single policy in a given product", "operationId": "getContextPolicy_1", "parameters": [ { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } }, { "name": "policyUuid", "in": "path", "description": "Policy UUID (by running Policies - Organization and run Get Organization Policies, or the equivalent for Product or Project.)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "put": { "tags": [ "Policies - Product" ], "summary": "Update Product Policy", "description": "Updates a policy for a given product", "operationId": "updatePolicy_1", "parameters": [ { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } }, { "name": "policyUuid", "in": "path", "description": "Policy UUID (by running Policies - Organization and run Get Organization Policies, or the equivalent for Product or Project.)", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "delete": { "tags": [ "Policies - Product" ], "summary": "Delete Product Policy", "description": "Deletes a policy for a given product", "operationId": "deletePolicy_1", "parameters": [ { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } }, { "name": "policyUuid", "in": "path", "description": "Policy UUID (by running Policies - Organization and run Get Organization Policies, or the equivalent for Product or Project.)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/policies/priority": { "put": { "tags": [ "Policies - Product" ], "summary": "Update Product Policy Priorities", "description": "Updates the priority of policies in a given product. Policies are numbered and then evaluated sequentially. The request body should contain a list of policy UUIDs in the desired order, starting from highest priority. The service returns a list or ordered policies.", "operationId": "updatePriorities_1", "parameters": [ { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePrioritiesRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCollectionPolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/libraries/{libraryUuid}/customAttributes/{attributeUuid}/value": { "put": { "tags": [ "CustomAttribute - Product" ], "summary": "Set Custom Attribute", "description": "Edits the value of a custom attribute for a specified library, attribute, and context.", "operationId": "setCustomAttributeValue_1", "parameters": [ { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } }, { "name": "attributeUuid", "in": "path", "description": "Custom Attribute UUID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAttributeValueDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}": { "get": { "tags": [ "Entities - Product" ], "summary": "Get Product", "description": "Returns a product as identified by its token", "operationId": "getEntity_1", "parameters": [ { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseContextEntityDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "put": { "tags": [ "Entities - Product" ], "summary": "Rename Product", "description": "Renames the product identified by its token", "operationId": "updateProduct", "parameters": [ { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextEntityRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseProductDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "delete": { "tags": [ "Entities - Product" ], "summary": "Remove Product", "description": "Deletes a product as identified by its token", "operationId": "removeEntity_1", "parameters": [ { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/settings/whiteList/{uuid}": { "put": { "tags": [ "Settings - Whitelist" ], "summary": "Update single Whitelist Rule", "description": "Updates the properties of a single whitelist rule of an organization, including matching libraries, their vulnerability scores and the actions to take", "operationId": "updateOrgWhiteListSettings", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "description": "AllowList rule UUID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWhiteListRuleRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseWhiteListRuleDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "delete": { "tags": [ "Settings - Whitelist" ], "summary": "Delete Single Whitelist Rule", "description": "Deletes one of the whitelist rules of an organization", "operationId": "deleteOrgWhiteListSettings", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "description": "Whitelist rule UUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/settings/whiteList/rules": { "put": { "tags": [ "Settings - Whitelist" ], "summary": "Update Whitelist Rules", "description": "Updates an organization's whitelist rules for vulnerability scores and the actions to take with libraries that appear in the whitelist", "operationId": "updateWhiteListRulesSettings", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateWhiteListRulesRequestDTO" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "Settings - Whitelist" ], "summary": "Add Whitelist Rules", "description": "Creates multiple new whitelist rules for an organization, defining which libraries to match, their vulnerability scores and the actions to take. Whitelisted libraries have been pre-approved by your organization so no policy alerts will be created for them during scans, and they will be ignored by all organizational policies.", "operationId": "addWhiteListRulesSettings", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWhiteListRulesRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseListWhiteListRuleDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "delete": { "tags": [ "Settings - Whitelist" ], "summary": "Delete Whitelist Rules", "description": "Deletes all of the whitelist rules of an organization", "operationId": "deleteWhiteListRulesSettings", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteWhiteListRuleRequestDTO" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/settings/whiteList/apply": { "put": { "tags": [ "Settings - Whitelist" ], "summary": "Apply Whitelist Rules to Existing Inventory", "description": "Applies the current whitelist rules to an organization's inventory. Whitelisted libraries are pre-approved by the organization so no policy alerts will be created for them, and they will be ignored by all organizational policies.", "operationId": "applyWhiteListRules", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/settings/inHouse/{ruleUuid}": { "put": { "tags": [ "Settings - In-House" ], "summary": "Update single InHouse Rule", "description": "Updates a single In-House library rule", "operationId": "updateInHouseRule", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "ruleUuid", "in": "path", "description": "The In-House rule UUID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInHouseRuleRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseWarningInHouseRuleDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "delete": { "tags": [ "Settings - In-House" ], "summary": "Delete Single In-House Rule", "description": "Deletes a single In-House library rule", "operationId": "deleteInHouseRule", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "ruleUuid", "in": "path", "description": "The InHouse rule UUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/settings/inHouse/rules": { "put": { "tags": [ "Settings - In-House" ], "summary": "Update Multiple In-House Rules", "description": "Updates the pattern-mat§ching rules of an In-House library rule", "operationId": "updateAllowListRulesSettings", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateInHouseRulesRequestDTO" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "Settings - In-House" ], "summary": "Create Multiple In-House Rules", "description": "Creates one or more in-house library rules", "operationId": "addInHouseRules", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateInHouseRuleRequestDTO" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseWarningListInHouseRuleDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "delete": { "tags": [ "Settings - In-House" ], "summary": "Delete multiple InhHouse rules", "description": "Deletes one or more in-house library rules", "operationId": "deleteInHouseRules", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteInHouseRuleRequestDTO" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/settings/inHouse/apply": { "put": { "tags": [ "Settings - In-House" ], "summary": "Apply In-House Rules", "description": "Applies the current In-House library rules to a given organization. Use this request after creating and/or updating In-House rules", "operationId": "applyWhiteListRules_1", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/policies/{policyUuid}": { "get": { "tags": [ "Policies - Organization" ], "summary": "Get organization policy", "description": "Returns the given policy for a particular organization", "operationId": "getContextPolicy_2", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "policyUuid", "in": "path", "description": "Policy UUID (by running Policies - Organization and run Get Organization Policies, or the equivalent for Product or Project.)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "put": { "tags": [ "Policies - Organization" ], "summary": "Update Organization Policy", "description": "Updates a policy of a given organization", "operationId": "updatePolicy_2", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "policyUuid", "in": "path", "description": "Policy UUID (by running Policies - Organization and run Get Organization Policies, or the equivalent for Product or Project.)", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "delete": { "tags": [ "Policies - Organization" ], "summary": "Delete Organization Policy", "description": "Deletes the given policy for an organization", "operationId": "deletePolicy_2", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "policyUuid", "in": "path", "description": "Policy UUID (by running Policies - Organization and run Get Organization Policies, or the equivalent for Product or Project.)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/policies/priority": { "put": { "tags": [ "Policies - Organization" ], "summary": "Update Organization Policy Priorities", "description": "Updates the priority of policies in a given organization. Policies are numbered and then evaluated sequentially. The request body should contain a list of policy UUIDs in the desired order, starting from highest priority. The service returns a list or ordered policies.", "operationId": "updatePriorities_2", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePrioritiesRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCollectionPolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/libraries/{libraryUuid}/customAttributes/{attributeUuid}/value": { "put": { "tags": [ "CustomAttribute - Organization" ], "summary": "Set Custom Attribute", "description": "Edits the value of a custom attribute for a specified library, attribute, and context.", "operationId": "setCustomAttributeValue_2", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } }, { "name": "attributeUuid", "in": "path", "description": "Custom Attribute UUID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAttributeValueDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/groups/{groupUuid}": { "get": { "tags": [ "User Management - Groups" ], "summary": "Get Group", "description": "Returns the given group of an organization", "operationId": "getGroup", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "groupUuid", "in": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseGroupDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "put": { "tags": [ "User Management - Groups" ], "summary": "Update Group", "description": "Updates the properties of a given group", "operationId": "updateGroup", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "groupUuid", "in": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseGroupDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "delete": { "tags": [ "User Management - Groups" ], "summary": "Delete Group", "description": "Deletes the given group", "operationId": "deleteGroup", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "groupUuid", "in": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}": { "get": { "tags": [ "Entities - Organization" ], "summary": "Get Organization", "description": "Returns an organization as identified by its token. ", "operationId": "getEntity_2", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseContextEntityDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "put": { "tags": [ "Entities - Organization" ], "summary": "Rename Organization", "description": "Renames the organization identified by its token", "operationId": "updateDomain", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextEntityRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseDomainDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/policies/apply": { "post": { "tags": [ "Policies - Project" ], "summary": "Apply Project Policies on Inventory", "description": "After initiating this call, the process will be performed asynchronously in the background. To check the status of the process and retrieve the final outcome, use the \"Get Async Process Status\" request.", "operationId": "applyOnInventory", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseAsyncProcessStatusV2DTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/policies": { "get": { "tags": [ "Policies - Project" ], "summary": "Get Project Policies", "description": "Returns all of the policies of a given project", "operationId": "getContextPolicies", "parameters": [ { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n+ Value: the value of the property.\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ aggregatePolicies:[equals]:value. Value can be either **true** or **false**", "allowEmptyValue": true }, { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCollectionPolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "Policies - Project" ], "summary": "Create Project Policy", "description": "Creates a new policy for a given project", "operationId": "createPolicy", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/profile/userKeys": { "get": { "tags": [ "User Profile" ], "summary": "Get All User Keys", "description": "Returns a list of existing user-keys for the current user. These keys are included in all API requests to identify the user", "operationId": "getUserKeys", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionUserKeyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "User Profile" ], "summary": "Generate User Key", "description": "Generates a user-key for the current user. User-keys are included in all api requests to identify the user", "operationId": "generateUserKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateUserKeyRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseUserKeyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/projects": { "get": { "tags": [ "Entities - Product" ], "summary": "Get Product Projects", "description": "Returns a list of the projects and their tokens for a given product", "operationId": "getProjects", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionProjectDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "Entities - Product" ], "summary": "Create Project", "description": "Creates a new project within a given product. If the project already exists it returns the existing project.", "operationId": "createProject", "parameters": [ { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectByProductRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCreatedProjectDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/policies/apply": { "post": { "tags": [ "Policies - Product" ], "summary": "Apply Product Policies On Inventory", "description": "After initiating this call, the process will be performed asynchronously in the background. To check the status of the process and retrieve the final outcome, use the \"Get Async Process Status\" request.", "operationId": "applyOnInventory_1", "parameters": [ { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseAsyncProcessStatusV2DTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/policies": { "get": { "tags": [ "Policies - Product" ], "summary": "Get Product Policies", "description": "Returns all policies of a given product", "operationId": "getContextPolicies_1", "parameters": [ { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCollectionPolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "Policies - Product" ], "summary": "Create Product Policy", "description": "Creates a new policy for a given product", "operationId": "createPolicy_1", "parameters": [ { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/libraries/byProjects": { "post": { "tags": [ "Library - Product" ], "summary": "Get Product Libraries by project Ids", "description": "Returns all libraries that are included in a given projects", "operationId": "getLibrariesByProjectIds", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ description:[like | equals | regex]:value\n+ directDependency:[like | equals | regex]:value\n+ hasNotice:[like | equals | regex]:value\n+ license:[like | equals | regex | in]:value\n+ locations:[like | equals | regex]:value\n+ name:[like | equals | regex]:value\n+ numberOfLicenses:[equals | gt]:value\n+ projectName:[like | equals | regex]:value\n+ type:[like | in | equals | regex]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ description\n+ directDependency\n+ hasNotice\n+ license\n+ locations\n+ name\n+ numberOfLicenses\n+ projectName\n+ type", "allowEmptyValue": true }, { "name": "optionalColumns", "in": "query", "description": "Used to add location information about the library", "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "locations" ] } }, { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } }, { "name": "includeNotices", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "extraInformation", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectListRequestDTO" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseListProjectLibraryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/users/service/{userUuid}/regenerateUserKey": { "post": { "tags": [ "User Management - Users" ], "summary": "Regenerate Service User Key", "description": "Removes current service user's key and creates a new one", "operationId": "regenerateServiceUserKey", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "userUuid", "in": "path", "description": "User UUID (by running User Management - Users > Get Organization Users).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseUserKeyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/users/service": { "post": { "tags": [ "User Management - Users" ], "summary": "Create Service User", "description": "Creates a new service user", "operationId": "createServiceUser", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserEmailRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseServiceUserDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/users/scan-summary-receiver-user": { "post": { "tags": [ "User Management - Users" ], "summary": "Create Scan summary receiver User", "description": "Creates a new scan summary receiver user ", "operationId": "createScanSummaryReceiverUser", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserEmailRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseScanSummaryReceiverUserDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/users/invite": { "post": { "tags": [ "User Management - Users" ], "summary": "Invite User", "description": "Sends an email invitation to others to join an organization", "operationId": "inviteUser", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteUserRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseUserInfoResponseDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/users/info": { "post": { "tags": [ "User Management - Users" ], "summary": "Get Enriched Organization Users", "description": "Returns detailed information about an organization's users", "operationId": "getEnrichedUserInfo", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserEmailsRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseListEnrichedUserInfoDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/users": { "get": { "tags": [ "User Management - Users" ], "summary": "Get Organization Users", "description": "Returns a list of all users in an organization (paginated)", "operationId": "getUsersPaginated", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ accountStatus:[equals|in]:value\n+ email:[like | equals | regex]:value\n+ name:[like | equals | regex]:value\n+ userType:[like | equals]:value\n+ roles:[equals|in]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ email\n+ name\n+ userType", "allowEmptyValue": true }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableListUserInfoDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "User Management - Users" ], "summary": "Create User", "description": "Creates a new user", "operationId": "createUser", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseUserInfoDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/updateRequest": { "post": { "tags": [ "Update Request" ], "summary": "Upload Update Request", "description": "Uploads information about a project's files, packages and dependencies, to be checked against Mend’s open source index, with the results viewable in the web app.", "operationId": "uploadUpdateRequest", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "update request file to upload", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/settings/whiteList": { "get": { "tags": [ "Settings - Whitelist" ], "summary": "Get All Whitelist Rules", "description": "Retrieves all of the whitelist rules of an organization. Whitelisted libraries are pre-approved by the organization so no policy alerts will be created for them, and they will be ignored by all organizational policies", "operationId": "getOrgWhiteListSettings", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableListWhiteListRuleDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "Settings - Whitelist" ], "summary": "Add Single Whitelist Rule", "description": "Creates a new whitelist rule for an organization, defining which libraries to match along, their vulnerability scores and the actions to take. Whitelisted libraries have been pre-approved by your organization so no policy alerts will be created for them during scans, and they will be ignored by all organizational policies.", "operationId": "addOrgWhiteListSettings", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWhiteListRuleRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseWhiteListRuleDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/settings/inHouse": { "get": { "tags": [ "Settings - In-House" ], "summary": "Get In-House Settings", "description": "Returns a list of all In-House library rules for a given organization", "operationId": "getOrgProprietaryRules", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableInHouseSettingsDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "Settings - In-House" ], "summary": "Create Single In-House Rule", "description": "Creates a single In-House rule to match libraries by name or maven coordinates (artifact id, group id) and designate these libraries as known, trusted entities", "operationId": "addProprietaryRule", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInHouseRuleRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseWarningInHouseRuleDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/projects": { "get": { "tags": [ "Entities - Organization" ], "summary": "Get Organization Projects", "description": "Returns a list of all projects accessible to the current user", "operationId": "getProjects_1", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "populateProducts", "in": "query", "description": "Add populateProducts=false to receive a slimmer response containing only the project UUID and name.", "allowEmptyValue": true, "schema": { "type": "string", "default": "true" } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionProjectDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "Entities - Organization" ], "summary": "Create Project With A New Product", "description": "Creates a new project within a new product. If project name exists will return existing project", "operationId": "createProject_1", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectByOrganizationRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCreatedCreateProjectResponseDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/products": { "get": { "tags": [ "Entities - Organization" ], "summary": "Get Organization Products", "description": "Returns a list of all products accessible to the current user", "operationId": "getProducts", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionProductDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "Entities - Organization" ], "summary": "Create Product", "description": "Creates a new product, If the product already exists it returns the existing product", "operationId": "createProduct", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProductDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCreatedProductDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/policies/apply": { "post": { "tags": [ "Policies - Organization" ], "summary": "Apply Organization Policies On Inventory", "description": "After initiating this call, the process will be performed asynchronously in the background. To check the status of the process and retrieve the final outcome, use the \"Get Async Process Status\" request.", "operationId": "applyOnInventory_2", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseAsyncProcessStatusV2DTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/policies": { "get": { "tags": [ "Policies - Organization" ], "summary": "Get organization policies", "description": "Returns all of the policies of a given organization", "operationId": "getContextPolicies_2", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCollectionPolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "Policies - Organization" ], "summary": "Create Organization Policy", "description": "Creates a new policy for a given organization", "operationId": "createPolicy_2", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePolicyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/libraries/{libraryUuid}/notices": { "get": { "tags": [ "Library - Organization" ], "summary": "Get Library Notices", "description": "Returns the text of a library's notice", "operationId": "getLibraryNotices", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseListNoticeDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "Library - Organization" ], "summary": "Set Library Notice", "description": "Edits or adds a custom notice for a given library", "operationId": "setLibraryNotice", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoticeDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseNoticeDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/libraries/{libraryUuid}/licenses": { "post": { "tags": [ "Library - Organization" ], "summary": "Assign Library License", "description": "Adds a license reference to a given library", "operationId": "addLicenseReference", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LibraryLicenseRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseLibraryLicenseDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/libraries/{libraryUuid}/copyrights": { "post": { "tags": [ "Library - Organization" ], "summary": "Set Library Copyright", "description": "Edits or adds a copyright statement for a given library", "operationId": "setLibraryCopyright", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyrightReferenceRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseUserCopyrightReferenceDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "delete": { "tags": [ "Library - Organization" ], "summary": "Revert Library User Copyrights", "description": "Reverts the copyright statement for a given library to its original text", "operationId": "revertLibraryCopyright", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseString" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/libraries/inHouse": { "get": { "tags": [ "Library - Organization" ], "summary": "Get Organization In-House Libraries", "description": "Retrieves all libraries in an organization that have been marked as In-House", "operationId": "getProprietaryLibraries_2", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on this property:\n+ name:[like | equals | regex]:value\n+ type:[like | equals ]:value\n+ comment:[like | equals | regex]:value\n+ markType:[equals]:value\n", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ name\n+ type\n+ comment\n+ markType\n", "allowEmptyValue": true }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableListLightLibraryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "Library - Organization" ], "summary": "Mark/Unmark Library As In-House", "description": "Marks/unmarks a single library in an organization as In-House", "operationId": "proprietary", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InHouseRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseBoolean" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/groups/{groupUuid}/users": { "get": { "tags": [ "User Management - Groups" ], "summary": "Get Group Users", "description": "Returns a list of users that belong to given group", "operationId": "getGroupUsers", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ accountStatus:[equals|in]:value\n+ email:[like | equals | regex]:value\n+ name:[like | equals | regex]:value\n+ userType:[like | equals]:value\n+ roles:[equals|in]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ email\n+ name\n+ userType", "allowEmptyValue": true }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "groupUuid", "in": "path", "description": "The group UUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableListUserInfoDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "User Management - Groups" ], "summary": "Add User To Group", "description": "Adds a user to an organization's group", "operationId": "addUsersToGroup", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "groupUuid", "in": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserEmailsRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/groups/{groupUuid}/roles": { "get": { "tags": [ "User Management - Groups" ], "summary": "Get Group Roles", "description": "Returns the list of roles associated with a given group", "operationId": "getGroupRoles", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ contextName:[like | equals | regex]:value\n+ contextType[like | equals]:value\n+ role[like | equals | regex]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ contextName\n+ contextType\n+ role", "allowEmptyValue": true }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "groupUuid", "in": "path", "description": "The group UUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableListMultipleGroupRolesPerContextDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "User Management - Groups" ], "summary": "Add Group Role", "description": "Creates a new group role for an organization", "operationId": "addGroupRoles", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "groupUuid", "in": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupRoleRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseGroupRoleDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "delete": { "tags": [ "User Management - Groups" ], "summary": "Remove Group Roles", "description": "Deletes a role from a group", "operationId": "removeGroupRoles", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "groupUuid", "in": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupRoleRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/groups": { "get": { "tags": [ "User Management - Groups" ], "summary": "Get All Groups of organization", "description": "Returns a list of all groups within an organization", "operationId": "getAllOrganizationGroups", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ contextType:equals:value\n+ name:[like | equals | regex]:value\n+ product:in:value1,value2,value-n\n+ roles:in:value1,value2,value-n", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ accountStatus\n+ contextType\n+ name\n+ product\n+ role\n+ users", "allowEmptyValue": true }, { "name": "groupRolesByScope", "in": "query", "description": "This query parameter allows you to group the roles assigned to a group by their scope (application/org). When set to true, the response will organize the roles into groups based on their associated application labels. This makes it easier to see which roles are linked to which applications within the group. ", "allowEmptyValue": true }, { "name": "optionalColumns", "in": "query", "description": "Used to add group roles information to the response", "allowEmptyValue": true, "schema": { "type": "string", "default": "roles", "enum": [ "roles" ] } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableListGroupSummaryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "User Management - Groups" ], "summary": "Create Group", "description": "Creates a new group for an organization", "operationId": "createGroup", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGroupRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseGroupDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs": { "get": { "tags": [ "Entities - Organization", "Access Management - Organizations" ], "summary": "Get User Organizations", "description": "Returns a list of all organizations where the current user is a member.", "operationId": "getUserDomains", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCollectionDomainDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } }, "post": { "tags": [ "Entities - Organization" ], "summary": "Create Organization", "description": "Creates a new organization", "operationId": "createDomain", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextEntityRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseDomainDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/login/accessToken": { "post": { "tags": [ "Access Management" ], "summary": "Refresh Access Token", "description": "Generate a new access token using the provided refresh token.", "operationId": "refreshAccessToken", "parameters": [ { "name": "wss-refresh-token", "in": "header", "description": "Enter the refreshToken received from the login response." } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionInfo" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/login": { "post": { "tags": [ "Access Management" ], "summary": "Login", "description": "Sign in a user with email and user key, returning a JWT token which is valid for 10 minutes.\nIf you omit the organization, it defaults to the last one you signed in to. ", "operationId": "login", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginModelDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseSessionInfo" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/vulnerabilities/{vulnerabilityId}/remediation": { "get": { "tags": [ "General Info - Vulnerabilities" ], "summary": "Get Vulnerability Remediation Proposals", "description": "Returns the recommended remediation actions to take for a given vulnerability", "operationId": "getVulnerabilityRemediationProposals", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability Name in the form of CVE-xxxx-xxx or WS-xxxx-xxx.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseVulnerabilityFixSummaryInfoDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/vulnerabilities/{vulnerabilityId}": { "get": { "tags": [ "General Info - Vulnerabilities" ], "summary": "Get Vulnerability Profile", "description": "Returns a complete vulnerability profile of a given CVE-ID", "operationId": "getVulnerabilityProfile", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability Name in the form of CVE-xxxx-xxx or WS-xxxx-xxx.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseVulnerabilityProfileDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/vitals": { "get": { "tags": [ "Entities - Project" ], "summary": "Get Project Vitals", "description": "Returns basic information about a given project", "operationId": "getVitals", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseVitalsDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/sourceFiles/inventory": { "get": { "tags": [ "Library - Source Files" ], "summary": "Get project source files inventory", "description": "Returns an inventory list of the source files associated with each library in a project", "operationId": "getSourceFiles", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **between** - true if the value is inside a range. Syntax: lowest value comma (,) highest value. E.g. between:2019-05-01,2019-06-01\n + **equals** - true if the value is identical to this value.\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ lastModified:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ libraryName:[like | equals | regex]:value\n+ license:[like | regex]:value\n+ matchType:equals:value\n+ name:[like | equals | regex]:value\n+ sha1:[like | equals | regex]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ lastModified\n+ libraryName\n+ license\n+ matchType\n+ name\n+ sha1", "allowEmptyValue": true }, { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionSourceFileInventoryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/permissions": { "get": { "tags": [ "User Management - Roles And Permissions" ], "summary": "Get User Project Permissions", "description": "Returns the actions permitted actions to the current user in a given project", "operationId": "getUserPermissions", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseUserPermissionListDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/libraries/{libraryUuid}/vulnerabilities": { "get": { "tags": [ "Library - Project" ], "summary": "Get Project Library Vulnerabilities", "description": "Returns a list of the vulnerabilities in the libraries of a given project", "operationId": "getLibraryVulnerabilities", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseListVulnerabilityProfileDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/libraries/{libraryUuid}/paths": { "get": { "tags": [ "Library - Project" ], "summary": "Get Project Library Impact", "description": "Returns the dependency paths of a given library in a particular project. ", "operationId": "getLibraryImpact", "parameters": [ { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCollectionLibraryImpactDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/libraries/licenses": { "get": { "tags": [ "Library - Project" ], "summary": "Get Project Due Diligence Info", "description": "Returns a due diligence report listing the source and license information for all libraries in a project", "operationId": "getDueDiligenceInfoByMultipleContexts", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ componentName[like | equals | regex]:value\n+ copyrights[like | regex]:value\n+ license[equals | in]:value\n+ licenseRisk[equals | in]:value\n+ licenseType[equals | in]:value\n", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ componentName\n+ copyrights\n+ license\n+ licenseRisk\n+ licenseType", "allowEmptyValue": true }, { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableListDueDiligenceDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/libraries/inHouse": { "get": { "tags": [ "Library - Project" ], "summary": "Get In-House Libraries", "description": "Returns all libraries in a given project that have been designated as \"In-House\". They will not trigger any alerts or be included in license analysis.", "operationId": "getProprietaryLibraries", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on this property:\n+ name:[like | equals | regex]:value\n+ type:[like | equals ]:value\n+ comment:[like | equals | regex]:value\n+ markType:[equals]:value\n", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ name\n+ type\n+ comment\n+ markType\n", "allowEmptyValue": true }, { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableListLightLibraryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/libraries": { "get": { "tags": [ "Library - Project" ], "summary": "Get Project Libraries", "description": "Returns the set of libraries used by a particular project", "operationId": "getLibraries", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ description:[like | equals | regex]:value\n+ directDependency:[like | equals | regex]:value\n+ hasNotice:[like | equals | regex]:value\n+ license:[like | equals | regex | in]:value\n+ locations:[like | equals | regex]:value\n+ name:[like | equals | regex]:value\n+ numberOfLicenses:[equals | gt]:value\n+ projectName:[like | equals | regex]:value\n+ type:[like | in | equals | regex]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ description\n+ directDependency\n+ hasNotice\n+ license\n+ locations\n+ name\n+ numberOfLicenses\n+ projectName\n+ type", "allowEmptyValue": true }, { "name": "optionalColumns", "in": "query", "description": "Used to add location information about the library", "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "locations" ] } }, { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } }, { "name": "includeNotices", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "extraInformation", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableListLibraryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/alerts/security/groupBy/component": { "get": { "tags": [ "Alerts - Project" ], "summary": "Get Security Alerts By Library", "description": "Returns all security alerts for a given project, including library and severity information, arranged by library", "operationId": "getLibrarySecurityVulnerabilityAlerts", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **between** - true if the value is inside a range. Syntax: lowest value comma (,) highest value. E.g. between:2019-05-01,2019-06-01\n + **equals** - true if the value is identical to this value.\n + **gt** - true if the value is greater than this value.\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters can be space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ comment:[like | equals | regex]:value\n+ commentBy:[like | equals | regex]:value\n+ componentName:[like | equals | regex]:value\n+ criticalNum:gt:value\n+ detectedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ directDependency:equals:value\n+ effective:[like | in | equals | regex]:value\n+ hasFix:equals:value\n+ highNum:gt:value\n+ lastCveUpdatedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ lowNum:gt:value\n+ mediumNum:gt:value\n+ modifiedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ projectName:[like | equals | regex]:value\n+ publishedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ score:between:lowvalue,highvalue\n+ scoreType:[like | equals | regex]:value\n+ severity:[like | equals | regex]:value\n+ sourceFileName:[like | equals | regex]:value\n+ status:[in | equals]:value\n+ vulnerabilityName:[like | equals | regex]:value\n+ vulnerabilityType:[equals | in]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ comment\n+ commentUserName\n+ componentName\n+ detectedAt\n+ directDependency\n+ effective\n+ highNum\n+ lastCveUpdatedAt\n+ lowNum\n+ mediumNum\n+ modifiedAt\n+ projectName\n+ publishedAt\n+ score\n+ scoreType\n+ severity\n+ status\n+ vulnerabilityName\n+ vulnerabilityType\n+ weight", "allowEmptyValue": true }, { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionSecurityAlertLibraryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/alerts/security": { "get": { "tags": [ "Alerts - Project" ], "summary": "Get project security alerts", "description": "Returns all security alerts for a given project, including library and severity information", "operationId": "getSecurityVulnerabilityAlerts", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **between** - true if the value is inside a range. Syntax: lowest value comma (,) highest value. E.g. between:2019-05-01,2019-06-01\n + **equals** - true if the value is identical to this value.\n + **gt** - true if the value is greater than this value.\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ comment:[like | equals | regex]:value\n+ commentUserEmail:[like | equals | regex]:value\n+ componentName:[like | equals | regex]:value\n+ detectedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ directDependency:equals:value\n+ effective:[like | equals | regex | in]:value\n+ hasFix:equals:value\n+ lastCveUpdatedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ modifiedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ projectName:[like | equals | regex]:value\n+ score:between:lowvalue,highvalue\n+ scoreType:[like | equals | regex]:value\n+ severity:[like | equals | regex]:value\n+ sourceFileName:[like | equals | regex]:value\n+ status:[in | equals]:value\n+ vulnerabilityName:[like | equals | regex]:value\n+ vulnerabilityType:[equals | in]:value\n+ libraryType:[equals | in | like | regex]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ comment\n+ commentUserEmail\n+ componentName\n+ detectedAt\n+ directDependency\n+ effective\n+ hasFix\n+ lastCveUpdatedAt\n+ modifiedAt\n+ projectName\n+ score\n+ scoreType\n+ severity\n+ sourceFileName\n+ status\n+ vulnerabilityName\n+ vulnerabilityType\n+ libraryType", "allowEmptyValue": true }, { "name": "optionalColumns", "in": "query", "description": "Used to add alert integration and library location information", "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "integration", "minimalFixVersionFromExtraData", "locations" ] } }, { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionSecurityAlertDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/projects/{projectToken}/alerts/legal": { "get": { "tags": [ "Alerts - Project" ], "summary": "Get project legal and compliance alerts", "description": "Returns a list of legal and compliance alerts arising from licensing issues (not vulnerabilities) for a given project", "operationId": "getLegalAndComplianceAlerts", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **between** - true if the value is inside a range. Syntax: lowest value comma (,) highest value. E.g. between:2019-05-01,2019-06-01\n + **equals** - true if the value is identical to this value.\n + **gt** - true if the value is greater than this value.\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ availableVersion:equals:value\n+ availableVersionType:[equals | in]:value\n+ comment:[like | equals | regex]:value\n+ commentUserEmail:[like | equals | regex]:value\n+ componentName:[like | equals | regex]:value\n+ componentType:[equals | in]:value\n+ detectedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ license:[like | regex ]:value\n+ modifiedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ numberOfLicenses:[gt | equals]:value\n+ policyName:[like | equals | regex]:value\n+ projectName:[like | equals | regex]:value\n+ status:[in | equals]:value\n+ type:[equals | in]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ availableVersionType\n+ comment\n+ componentName\n+ componentType\n+ detectedAt\n+ modifiedAt\n+ numberOfLicenses\n+ policyName\n+ status\n+ type\n+ versionType", "allowEmptyValue": true }, { "name": "projectToken", "in": "path", "description": "project UUID (by running Entities - Product > Get Product Projects) or Project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionLegalAndComplianceAlertBaseDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/sourceFiles/inventory": { "get": { "tags": [ "Library - Source Files" ], "summary": "Get product source files inventory", "description": "Returns a list of libraries together with the location of their source files", "operationId": "getSourceFiles_1", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **between** - true if the value is inside a range. Syntax: lowest value comma (,) highest value. E.g. between:2019-05-01,2019-06-01\n + **equals** - true if the value is identical to this value.\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ lastModified:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ libraryName:[like | equals | regex]:value\n+ license:[like | regex]:value\n+ matchType:equals:value\n+ name:[like | equals | regex]:value\n+ projectName:[like | equals | regex]:value\n+ sha1:[like | equals | regex]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ lastModified\n+ libraryName\n+ license\n+ matchType\n+ name\n+ path\n+ projectName\n+ sha1", "allowEmptyValue": true }, { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionSourceFileInventoryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/permissions": { "get": { "tags": [ "User Management - Roles And Permissions" ], "summary": "Get User Product Permissions", "description": "This api returns the list of permitted actions for the logged-in user and the a given product", "operationId": "getUserPermissions_1", "parameters": [ { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseUserPermissionListDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/libraries/{libraryUuid}/vulnerabilities": { "get": { "tags": [ "Library - Product" ], "summary": "Get Product Library Vulnerabilities", "description": "Returns a list of the vulnerabilities in the libraries of a given product", "operationId": "getLibraryVulnerabilities_1", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableListVulnerabilityProfileDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/libraries/{libraryUuid}/projects": { "get": { "tags": [ "Library - Product" ], "summary": "Get Library Projects", "description": "Returns all of the projects in a particular product that contain a given library ", "operationId": "getLibraryProjects", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCollectionProjectDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/libraries/licenses": { "get": { "tags": [ "Library - Product" ], "summary": "Get Product Due Diligence Info", "description": "Returns a due diligence report listing the source and license information for all libraries in a product", "operationId": "getDueDiligenceInfoByMultipleContexts_1", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ componentName:[like | equals | regex]:value\n+ copyrights:[like | regex]:value\n+ license:[equals | in]:value\n+ licenseRisk:[equals | in]:value\n+ licenseType:[equals | in]:value\n+ projectName:[like | equals | regex]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ componentName\n+ license\n+ licenseType\n+ copyrights\n+ licenseRisk\n+ projectName", "allowEmptyValue": true }, { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableListDueDiligenceDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/libraries/inHouse": { "get": { "tags": [ "Library - Product" ], "summary": "Get In-House Libraries", "description": "Returns all libraries in a given product that have been designated as \"In-House\". They will not trigger any alerts or be included in license analysis. so that they will not trigger any alerts or be included in license analysis.", "operationId": "getProprietaryLibraries_1", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on this property:\n+ name:[like | equals | regex]:value\n+ type:[like | equals ]:value\n+ comment:[like | equals | regex]:value\n+ markType:[equals]:value\n", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ name\n+ type\n+ comment\n+ markType\n", "allowEmptyValue": true }, { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableListLightLibraryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/libraries": { "get": { "tags": [ "Library - Product" ], "summary": "Get Product Libraries", "description": "Returns all libraries that are included in a given product", "operationId": "getLibraries_1", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ description:[like | equals | regex]:value\n+ directDependency:[like | equals | regex]:value\n+ hasNotice:[like | equals | regex]:value\n+ license:[like | equals | regex | in]:value\n+ locations:[like | equals | regex]:value\n+ name:[like | equals | regex]:value\n+ numberOfLicenses:[equals | gt]:value\n+ projectName:[like | equals | regex]:value\n+ type:[like | in | equals | regex]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ description\n+ directDependency\n+ hasNotice\n+ license\n+ locations\n+ name\n+ numberOfLicenses\n+ projectName\n+ type", "allowEmptyValue": true }, { "name": "optionalColumns", "in": "query", "description": "Used to add location information about the library", "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "locations" ] } }, { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } }, { "name": "includeNotices", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "extraInformation", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseListProjectLibraryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/alerts/security/groupBy/component": { "get": { "tags": [ "Alerts - Product" ], "summary": "Get Security Alerts By Library", "description": "Returns security alerts for a given product grouped by library", "operationId": "getLibrarySecurityVulnerabilityAlerts_1", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **between** - true if the value is inside a range. Syntax: lowest value comma (,) highest value. E.g. between:2019-05-01,2019-06-01\n + **equals** - true if the value is identical to this value.\n + **gt** - true if the value is greater than this value.\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters can be space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ comment:[like | equals | regex]:value\n+ commentBy:[like | equals | regex]:value\n+ componentName:[like | equals | regex]:value\n+ criticalNum:gt:value\n+ detectedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ directDependency:equals:value\n+ effective:[like | in | equals | regex]:value\n+ hasFix:equals:value\n+ highNum:gt:value\n+ lastCveUpdatedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ lowNum:gt:value\n+ mediumNum:gt:value\n+ modifiedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ projectName:[like | equals | regex]:value\n+ publishedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ score:between:lowvalue,highvalue\n+ scoreType:[like | equals | regex]:value\n+ severity:[like | equals | regex]:value\n+ sourceFileName:[like | equals | regex]:value\n+ status:[in | equals]:value\n+ vulnerabilityName:[like | equals | regex]:value\n+ vulnerabilityType:[equals | in]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ comment\n+ commentUserName\n+ componentName\n+ detectedAt\n+ directDependency\n+ effective\n+ highNum\n+ lastCveUpdatedAt\n+ lowNum\n+ mediumNum\n+ modifiedAt\n+ projectName\n+ publishedAt\n+ score\n+ scoreType\n+ severity\n+ status\n+ vulnerabilityName\n+ vulnerabilityType\n+ weight", "allowEmptyValue": true }, { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionSecurityAlertLibraryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/alerts/security": { "get": { "tags": [ "Alerts - Product" ], "summary": "Get Product Security Alerts", "description": "Returns all security alerts for a given product", "operationId": "getSecurityVulnerabilityAlerts_1", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **between** - true if the value is inside a range. Syntax: lowest value comma (,) highest value. E.g. between:2019-05-01,2019-06-01\n + **equals** - true if the value is identical to this value.\n + **gt** - true if the value is greater than this value.\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ comment:[like | equals | regex]:value\n+ commentUserEmail:[like | equals | regex]:value\n+ componentName:[like | equals | regex]:value\n+ detectedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ directDependency:equals:value\n+ effective:[like | equals | regex | in]:value\n+ hasFix:equals:value\n+ lastCveUpdatedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ modifiedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ projectName:[like | equals | regex]:value\n+ score:between:lowvalue,highvalue\n+ scoreType:[like | equals | regex]:value\n+ severity:[like | equals | regex]:value\n+ sourceFileName:[like | equals | regex]:value\n+ status:[in | equals]:value\n+ vulnerabilityName:[like | equals | regex]:value\n+ vulnerabilityType:[equals | in]:value\n+ libraryType:[equals | in | like | regex]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ comment\n+ commentUserEmail\n+ componentName\n+ detectedAt\n+ directDependency\n+ effective\n+ hasFix\n+ lastCveUpdatedAt\n+ modifiedAt\n+ projectName\n+ score\n+ scoreType\n+ severity\n+ sourceFileName\n+ status\n+ vulnerabilityName\n+ vulnerabilityType\n+ libraryType", "allowEmptyValue": true }, { "name": "optionalColumns", "in": "query", "description": "Used to add alert integration and library location information", "allowEmptyValue": true, "schema": { "type": "string", "enum": [ "integration", "locations" ] } }, { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionSecurityAlertDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productToken}/alerts/legal": { "get": { "tags": [ "Alerts - Product" ], "summary": "Get Product Legal And Compliance Alerts", "description": "Returns all legal and compliance alerts for a given product", "operationId": "getLegalAndComplianceAlerts_1", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **between** - true if the value is inside a range. Syntax: lowest value comma (,) highest value. E.g. between:2019-05-01,2019-06-01\n + **equals** - true if the value is identical to this value.\n + **gt** - true if the value is greater than this value.\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ availableVersion:equals:value\n+ availableVersionType:[equals | in]:value\n+ comment:[like | equals | regex]:value\n+ commentUserEmail:[like | equals | regex]:value\n+ componentName:[like | equals | regex]:value\n+ componentType:[equals | in]:value\n+ detectedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ license:[like | regex ]:value\n+ modifiedAt:between:date1,date2. E.g. between:2019-05-01,2019-06-01\n+ numberOfLicenses:[gt | equals]:value\n+ policyName:[like | equals | regex]:value\n+ projectName:[like | equals | regex]:value\n+ status:[in | equals]:value\n+ type:[equals | in]:value", "allowEmptyValue": true }, { "name": "sort", "in": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ availableVersionType\n+ comment\n+ componentName\n+ componentType\n+ detectedAt\n+ modifiedAt\n+ numberOfLicenses\n+ policyName\n+ status\n+ type\n+ versionType", "allowEmptyValue": true }, { "name": "productToken", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionLegalAndComplianceAlertBaseDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/permissions/byRole": { "get": { "tags": [ "General Info - Permissions" ], "summary": "Get All Available Permissions Grouped By Roles", "description": "Returns a list of the current user's permissions grouped by roles", "operationId": "getAvailableRolePermissions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseListRolePermissionsDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/vulnerabilities/{vulnerabilityName}/libraries": { "get": { "tags": [ "Vulnerable Libraries" ], "summary": "Get Vulnerable Libraries By CVE", "description": "Returns all of the vulnerable libraries in an organization ordered by their associated CVE-ID", "operationId": "getVulnerableLibrariesByCVE", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "vulnerabilityName", "in": "path", "description": "Vulnerability Name in the form of CVE-xxxx-xxx or WS-xxxx-xxx.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseListLightLibraryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/users/service/{userUuid}/userKey": { "get": { "tags": [ "User Management - Users" ], "summary": "Get Service User Key", "description": "Returns service user's key", "operationId": "getServiceUsersKey", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "userUuid", "in": "path", "description": "User UUID (by running User Management - Users > Get Organization Users).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseUserKeyDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/users/self": { "get": { "tags": [ "User Management - Users" ], "summary": "Get self information of groups and roles", "description": "Returns information about the currently logged-in user, including group membership and roles", "operationId": "getSelfUserInfo", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseEnrichedUserInfoDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/summary/scanCountPerAgent": { "get": { "tags": [ "Summary - Organization" ], "summary": "Get Organization Scan Count Per Agent.", "description": "Returns the total number of scans in selected period and a breakdown per agent.\nThe selected period cannot have start date older 30 days before the current date. Also selected period cannot be greater than 30 days\n", "operationId": "getScanCountPerAgent", "parameters": [ { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **between** - true if the value is inside a range. Syntax: lowest value comma (,) highest value. E.g. between:2019-05-01,2019-06-01\n+ Value: the value of the property.\n\nThis endpoint supports filtering on this property:\n+ date:between:date1,date2. E.g. between:2019-05-10,2019-06-01. Difference between dates cannot be greater than 30 days\n", "allowEmptyValue": true }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseScanSummaryCountDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/summary/projects/vulnerableLibraryCount": { "get": { "tags": [ "Summary - Organization" ], "summary": "Get Organization Vulnerable Libraries Count By Projects", "description": "Returns vulnerable libraries count by projects for a given organization.", "operationId": "getVulnerableLibsCountByProjects", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ vulnerabilityId:[equals]:value\n+ productName:[like | equals | regex]:value\n+ projectName:[like | equals | regex]:value\n", "allowEmptyValue": true }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionVulnrerableLibrariesByProjectCountDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/summary/projects/totalLibraryCount": { "get": { "tags": [ "Summary - Organization" ], "summary": "Get Organization Libraries Count By Projects.", "description": "Returns the total number of libraries (non-unique) for a given organization with a breakdown per project", "operationId": "getLibsCountByProjects", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionLibraryCountByProjectDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/summary/projects/inHouseLibraries": { "get": { "tags": [ "Summary - Organization" ], "summary": "Get Organization In-House Libraries Count By Projects.", "description": "Returns the total number of in house libraries (non-unique) for a given organization with a breakdown per project.", "operationId": "getInHouseLibrariesByProjects", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableDomainSummeryInHouseLibraryPerProjectDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/summary/products/vulnerableLibraryCount": { "get": { "tags": [ "Summary - Organization" ], "summary": "Get Organization Vulnerable Libraries Count By Products", "description": "Returns vulnerable libraries count by products for a given organization.", "operationId": "getVulnerableLibsCountByProducts", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ vulnerabilityId:[equals]:value\n+ productName:[like | equals | regex]:value\n+ projectName:[like | equals | regex]:value\n", "allowEmptyValue": true }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionVulnerableLibrariesCountDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/summary/products/totalLibraryCount": { "get": { "tags": [ "Summary - Organization" ], "summary": "Get Organization Libraries Count By Products.", "description": "Returns the total number of libraries (non-unique) for a given organization with a breakdown per product", "operationId": "getLibsCountByProducts", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionLibraryCountByProductDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/summary/products/inHouseLibraries": { "get": { "tags": [ "Summary - Organization" ], "summary": "Get Organization In-House Libraries Count By Products.", "description": "Returns the total number of in house libraries (non-unique) for a given organization with a breakdown per product.", "operationId": "getInHouseLibrariesByProducts", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableDomainSummaryInHouseLibraryPerProductDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/summary/libraryCountPerLicense": { "get": { "tags": [ "Summary - Organization" ], "summary": "Get Libraries Count Per License", "description": "Returns the total number of libraries for a given organization, along with a breakdown of the number of libraries per license.", "operationId": "getLibraryCountPerLicense", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseLicenseCountDto" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/summary/libraryCountPerLanguage": { "get": { "tags": [ "Summary - Organization" ], "summary": "Get Libraries Count By Language", "description": "Returns the number of libraries with a breakdown per Language. The library count should be for all occurrences (nonunique) and only open source.", "operationId": "getLibraryCountPerLanguage", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseLibraryLanguageCountDto" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/summary/effective/vulnerabilityCountPerSeverity": { "get": { "tags": [ "Summary - Organization" ], "summary": "Get Vulnerability Alerts Count Per Effective Usage Status.", "description": "Vulnerability alert count per effective usage status.", "operationId": "getDomainVulnerabilityAlertCountPerEffectiveUsage", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "cvss4", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseVulnerabilityAlertCountPerEffectiveUsageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/summary/alertTypes": { "get": { "tags": [ "Summary - Organization" ], "summary": "Get Organization Alert Type Summaries", "description": "Returns the alerts count per type for a given organization.", "operationId": "getOrganizationAlertTypeSummaries", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "cvss4", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseDomainAlertTypeSummaryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/summary/alertCountPerSeverity": { "get": { "tags": [ "Summary - Organization" ], "summary": "Get Organization Alert Count Per Severity", "description": "Returns the active alerts count per severity for a given organization.", "operationId": "getOrganizationAlertCountPerSeverity", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "cvss4", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseSecurityAlertPerVulnerabilityDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/productEntities": { "get": { "tags": [ "Entities - Organization" ], "summary": "Get Organization Product Entities", "description": "Returns extended product information for all products in an organization", "operationId": "getDomainProductEntities", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionDomainEntitiesProductDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/permissions": { "get": { "tags": [ "User Management - Roles And Permissions" ], "summary": "Get User Organization Permissions", "description": "This api returns the listed of permitted actions for the logged-in user and the given organization", "operationId": "getUserPermissions_2", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseUserPermissionListDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/libraries/{libraryUuid}/vulnerabilityTrends": { "get": { "tags": [ "Library - Organization" ], "summary": "Get Library Version Vulnerability Trends", "description": "Returns the trend of the number of vulnerabilities in a library over past versions.\nDefine the scope of the trend with the parameters 'before' denoting the number of versions before the current version, and 'after'.\nDoes not support generic library types like Debian, RPM and Ruby", "operationId": "getLibraryTrends", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } }, { "name": "startVersion", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseLibraryVulnerabilityTrendsDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/libraries/{libraryUuid}/versions": { "get": { "tags": [ "Library - Organization" ], "summary": "Get Library Versions", "description": "Returns a list of a library's versions", "operationId": "getLibraryVersions", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } }, { "name": "removeUnstableVersions", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionLibraryVersionDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/libraries/{libraryUuid}/projects": { "get": { "tags": [ "Library - Organization" ], "summary": "Get Library Projects In Organization", "description": "Returns a list of an organization's projects that contain a particular library", "operationId": "getLibraryProjects_1", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionProjectDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/libraries/{libraryUuid}": { "get": { "tags": [ "Library - Organization" ], "summary": "Get Library Details", "description": "Returns a single library's details", "operationId": "getLibraryByUUID", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ignoreManualData", "in": "query", "description": "requestParameter called ignoreManualData, default value is false. In case the parameter is true, ignore manual changes of the user on the library", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseNoLocationsLibraryDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/entities": { "get": { "tags": [ "Entities - Organization" ], "summary": "Get Organization Entities", "description": "Returns all projects and their associated product for a given organization.", "operationId": "getDomainEntities", "parameters": [ { "name": "pageSize", "in": "query", "description": "Enter the number of items to return in each page of the result.", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "description": "Enter the page number to display in the result. Page numbers start at 0", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionDomainEntitiesDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/customAttributes": { "get": { "tags": [ "CustomAttribute - Organization" ], "summary": "Get Organization Custom Attributes", "description": "Retrieves all custom attributes in the given organization", "operationId": "getCustomAttributes", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n+ Value: the value of the property.\n+ context:[equals]:value", "allowEmptyValue": true }, { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableListCustomAttributeDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/changeOrganization/{otherOrgToken}": { "get": { "tags": [ "Entities - Organization", "Access Management - Organizations" ], "summary": "Change Organization", "description": "You can access a different organization by asking for a new JWT token for the new org. The previous JWT is still valid for the previous org until it expires. All JWT tokens are valid for 10 minutes.", "operationId": "changeDomain", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "otherOrgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseSessionInfo" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/asyncProcessStatus/{statusUuid}": { "get": { "tags": [ "Asynchronous Process Control" ], "summary": "Get Async Process Status", "description": " Returns the status of an asynchronous process. Asynchronous processes allow requests to be performed in\n the background, enabling you to initiate tasks and check their completion status later.\n\n **Requests Performed in Async Process:**\n+ Post Apply OrganizationPolicies On Inventory.\n+ Post Apply Product Policies On Inventory.\n+ Post Apply Project Policies On Inventory.", "operationId": "getReportStatus", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "statusUuid", "in": "path", "description": "Asynchronous Process Status UUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseAsyncProcessStatusV2DTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/managed-domains": { "get": { "tags": [ "domain-controller" ], "summary": "Get User Managed Domains", "description": "Returns a list of all organizations where the current user is a domain or application admin.", "operationId": "getUserManagedDomains", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCollectionDomainDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/licenses/{licenseName}": { "get": { "tags": [ "General Info - Licenses" ], "summary": "Get License Details", "description": "Returns detailed information about a specific license", "operationId": "getLicenseDetails", "parameters": [ { "name": "licenseName", "in": "path", "description": "license name (by running General Info - Licenses > Get All Licenses).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseLicenseDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/licenses": { "get": { "tags": [ "General Info - Licenses" ], "summary": "Get All Licenses", "description": "Returns a list of all known licenses in the system.", "operationId": "getAllLicenses", "parameters": [ { "name": "pageSize", "in": "query", "allowEmptyValue": true, "schema": { "maximum": 10000, "type": "string", "default": "50" } }, { "name": "page", "in": "query", "allowEmptyValue": true, "schema": { "type": "string", "default": "0" } }, { "name": "search", "in": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **like** - true if the property's value is contained within this value\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ name:[equals | like | in]:value\n+ spdxName:[equals | like | in]:value\n+ uuid:[equals | in]:value", "allowEmptyValue": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponsePageableCollectionLicenseDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/profile/userKeys/{userKey}": { "delete": { "tags": [ "User Profile" ], "summary": "Delete User Key", "description": "Deletes a user-key", "operationId": "deleteUserKey", "parameters": [ { "name": "userKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/products/{productIdentifier}/librarySettings/attributionReport": { "delete": { "tags": [ "product-attribution-report-controller" ], "summary": "Delete attribution report library settings", "description": "Delete library settings to be reflected in the attribution report", "operationId": "deleteAttributionReportLibrarySettings", "parameters": [ { "name": "productIdentifier", "in": "path", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectListRequestDTO" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/users/{userUuid}": { "delete": { "tags": [ "User Management - Users" ], "summary": "Remove User From Organization", "description": "Deletes a user from an organization", "operationId": "removeUser", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "userUuid", "in": "path", "description": "User UUID (by running User Management - Users > Get Organization Users).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/libraries/{libraryUuid}/licenses/{licenseUuid}": { "delete": { "tags": [ "Library - Organization" ], "summary": "Remove Library License References", "description": "Removes the license reference from a library", "operationId": "removeLicenseReference", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } }, { "name": "licenseUuid", "in": "path", "description": "license UUID to remove", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseString" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/libraries/{libraryUuid}/licenses/revert": { "delete": { "tags": [ "Library - Organization" ], "summary": "Revert Library User Licenses", "description": "Reverts the license for a given library to its original state", "operationId": "revertLicenseReferences", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "libraryUuid", "in": "path", "description": "library UUID (get a project's library by running Library - Project > Get Project Libraries.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseCollectionLibraryLicenseDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } }, "/api/v2.0/orgs/{orgToken}/groups/{groupUuid}/users/{userUuid}": { "delete": { "tags": [ "User Management - Groups" ], "summary": "Delete User From Group", "description": "Deletes a user from an organization's group", "operationId": "deleteUserFromGroup", "parameters": [ { "name": "orgToken", "in": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**).", "required": true, "schema": { "type": "string" } }, { "name": "groupUuid", "in": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization).", "required": true, "schema": { "type": "string" } }, { "name": "userUuid", "in": "path", "description": "User UUID (by running User Management - Users > Get Organization Users).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DWRResponseMessageDTO" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DWRResponseBase" } } } } } } } }, "components": { "schemas": { "DWRResponseBase": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" } } }, "DWRResponseMessageDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/MessageDTO" } } }, "MessageDTO": { "type": "object", "properties": { "message": { "title": "message", "type": "string", "example": "Success!" } } }, "APPROVE": { "type": "object", "description": "type: APPROVE", "allOf": [ { "$ref": "#/components/schemas/BasePolicyActionDTO" } ] }, "BasePolicyActionDTO": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "CONDITIONS": { "type": "object", "description": "type: CONDITIONS", "allOf": [ { "$ref": "#/components/schemas/BasePolicyActionDTO" }, { "type": "object", "properties": { "approveWhenAllSatisfied": { "title": "Approve When All Satisfied", "type": "boolean", "default": false }, "rejectWhenOneRejected": { "title": "Reject When One Condition is Rejected", "type": "boolean", "default": false }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionInfo" } }, "failPolicyCheck": { "title": "Fail Policy Check", "type": "boolean", "default": false } } } ] }, "CREATE_ISSUE": { "required": [ "issueTrackerType" ], "type": "object", "description": "type: CREATE_ISSUE", "allOf": [ { "$ref": "#/components/schemas/BasePolicyActionDTO" }, { "type": "object", "properties": { "failPolicyCheck": { "title": "Fail Policy Check", "type": "boolean", "default": false }, "issueTrackerType": { "title": "Issue Tracker Type", "type": "string", "example": "COMMON_ISSUE_TRACKER", "enum": [ "COMMON_ISSUE_TRACKER" ] } } } ] }, "ConditionInfo": { "required": [ "conditionText", "duePeriod" ], "type": "object", "properties": { "duty": { "type": "string", "enum": [ "REQUESTER", "APPROVER" ] }, "user": { "$ref": "#/components/schemas/PolicyUserDTO" }, "group": { "$ref": "#/components/schemas/PolicyGroupDTO" }, "conditionText": { "title": "Condition Description", "type": "string", "example": "A reason for the condition" }, "duePeriod": { "title": "Due Period", "type": "integer", "format": "int32", "example": 10 } }, "description": "Condition will apply to duty or user or group" }, "EFFECTIVENESS": { "required": [ "shieldValue" ], "type": "object", "properties": { "type": { "type": "string" }, "shieldValue": { "title": "Effective Value", "type": "string", "enum": [ "RED", "YELLOW", "GREY", "NO_SHIELD", "GREEN" ] } }, "description": "type: EFFECTIVENESS" }, "GAV_REGEX": { "type": "object", "properties": { "type": { "type": "string" }, "groupIdRegex": { "title": "Group Id Regex", "type": "string", "example": "/**" }, "artifactIdRegex": { "title": "Artifact Id Regex", "type": "string", "example": "/**" }, "versionRegex": { "title": "Version Regex", "type": "string", "example": "/**" } }, "description": "type: GAV_REGEX" }, "LIBRARY_REQUEST_HISTORY": { "required": [ "libraryRequestHistory" ], "type": "object", "properties": { "type": { "type": "string" }, "libraryRequestHistory": { "title": "Library Request History", "type": "string", "enum": [ "APPROVED_AT_LEAST_ONCE", "APPROVED_AT_LEAST_ONCE_OR_PENDING", "REJECTED_AT_LEAST_ONCE", "REJECTED_AT_LEAST_ONCE_OR_PENDING", "PENDING" ] } }, "description": "type: LIBRARY_REQUEST_HISTORY" }, "LIBRARY_STALENESS": { "required": [ "monthsBack" ], "type": "object", "properties": { "type": { "type": "string" }, "monthsBack": { "title": "Months Back", "type": "integer", "format": "int32", "example": 36 } }, "description": "type: LIBRARY_STALENESS" }, "LICENSE": { "required": [ "licenses" ], "type": "object", "properties": { "type": { "type": "string" }, "licenses": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyLicenseDTO" } }, "inclusive": { "title": "Inclusive", "type": "boolean", "description": "Trigger only when ALL licenses of the library are matched" } }, "description": "type: LICENSE" }, "PRIMARY_ATTRIBUTE_VALUE": { "required": [ "attributeValue" ], "type": "object", "properties": { "type": { "type": "string" }, "attributeValue": { "title": "Attribute Value", "type": "string", "example": "value" } }, "description": "type: PRIMARY_ATTRIBUTE_VALUE" }, "PRODUCT": { "required": [ "productToken" ], "type": "object", "properties": { "type": { "type": "string" }, "productToken": { "title": "Product Token", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "productName": { "title": "Product Name", "type": "string", "description": "product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**).", "example": "Product A" } }, "description": "type: PRODUCT" }, "PolicyGroupDTO": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "title": "Group Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Group Name", "type": "string", "example": "Group A" } } }, "PolicyLicenseDTO": { "required": [ "name" ], "type": "object", "properties": { "uuid": { "title": "License Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "License Name", "type": "string", "example": "MIT" } } }, "PolicyRequestDTO": { "required": [ "action", "filter", "name" ], "type": "object", "properties": { "name": { "title": "Policy Name", "type": "string", "example": "License Policy" }, "filter": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GAV_REGEX" }, { "$ref": "#/components/schemas/LIBRARY_REQUEST_HISTORY" }, { "$ref": "#/components/schemas/LIBRARY_STALENESS" }, { "$ref": "#/components/schemas/LICENSE" }, { "$ref": "#/components/schemas/PRIMARY_ATTRIBUTE_VALUE" }, { "$ref": "#/components/schemas/PRODUCT" }, { "$ref": "#/components/schemas/ReferenceNameRequiredException" }, { "$ref": "#/components/schemas/EFFECTIVENESS" }, { "$ref": "#/components/schemas/VULNERABILITY_SCORE" } ] }, "action": { "oneOf": [ { "$ref": "#/components/schemas/APPROVE" }, { "$ref": "#/components/schemas/CONDITIONS" }, { "$ref": "#/components/schemas/CREATE_ISSUE" }, { "$ref": "#/components/schemas/REASSIGN" }, { "$ref": "#/components/schemas/REJECT" } ] }, "enabled": { "title": "Enabled", "type": "boolean", "default": true } } }, "PolicyUserDTO": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "title": "User Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "User Name", "type": "string", "example": "jon.smith" }, "email": { "title": "User Name", "type": "string", "example": "jon.smith@mail.com" } } }, "REASSIGN": { "type": "object", "description": "type: REASSIGN", "allOf": [ { "$ref": "#/components/schemas/BasePolicyActionDTO" }, { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/PolicyUserDTO" }, "group": { "$ref": "#/components/schemas/PolicyGroupDTO" }, "failPolicyCheck": { "title": "Fail Policy Check", "type": "boolean", "default": false } } } ] }, "REJECT": { "type": "object", "description": "type: REJECT", "allOf": [ { "$ref": "#/components/schemas/BasePolicyActionDTO" } ] }, "ReferenceNameRequiredException": { "type": "object", "properties": { "cause": { "type": "object", "properties": { "stackTrace": { "type": "array", "items": { "type": "object", "properties": { "classLoaderName": { "type": "string" }, "moduleName": { "type": "string" }, "moduleVersion": { "type": "string" }, "methodName": { "type": "string" }, "fileName": { "type": "string" }, "lineNumber": { "type": "integer", "format": "int32" }, "className": { "type": "string" }, "nativeMethod": { "type": "boolean" } } } }, "message": { "type": "string" }, "suppressed": { "type": "array", "items": { "type": "object", "properties": { "stackTrace": { "type": "array", "items": { "type": "object", "properties": { "classLoaderName": { "type": "string" }, "moduleName": { "type": "string" }, "moduleVersion": { "type": "string" }, "methodName": { "type": "string" }, "fileName": { "type": "string" }, "lineNumber": { "type": "integer", "format": "int32" }, "className": { "type": "string" }, "nativeMethod": { "type": "boolean" } } } }, "message": { "type": "string" }, "localizedMessage": { "type": "string" } } } }, "localizedMessage": { "type": "string" } } }, "stackTrace": { "type": "array", "items": { "type": "object", "properties": { "classLoaderName": { "type": "string" }, "moduleName": { "type": "string" }, "moduleVersion": { "type": "string" }, "methodName": { "type": "string" }, "fileName": { "type": "string" }, "lineNumber": { "type": "integer", "format": "int32" }, "className": { "type": "string" }, "nativeMethod": { "type": "boolean" } } } }, "requestId": { "type": "string" }, "errorCode": { "type": "string" }, "errorType": { "type": "string", "enum": [ "Client", "Service", "Unknown" ] }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer", "format": "int32" }, "serviceName": { "type": "string" }, "httpHeaders": { "type": "object", "additionalProperties": { "type": "string" } }, "rawResponse": { "type": "array", "items": { "type": "string", "format": "byte" } }, "rawResponseContent": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "suppressed": { "type": "array", "items": { "type": "object", "properties": { "stackTrace": { "type": "array", "items": { "type": "object", "properties": { "classLoaderName": { "type": "string" }, "moduleName": { "type": "string" }, "moduleVersion": { "type": "string" }, "methodName": { "type": "string" }, "fileName": { "type": "string" }, "lineNumber": { "type": "integer", "format": "int32" }, "className": { "type": "string" }, "nativeMethod": { "type": "boolean" } } } }, "message": { "type": "string" }, "localizedMessage": { "type": "string" } } } }, "localizedMessage": { "type": "string" } } }, "VULNERABILITY_SCORE": { "type": "object", "properties": { "type": { "type": "string" }, "from": { "type": "number", "format": "float" }, "to": { "type": "number", "format": "float" } }, "description": "type: VULNERABILITY_SCORE" }, "BasePolicyFilterDTO": { "type": "object", "properties": { "type": { "type": "string" } } }, "DWRResponsePolicyDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/PolicyDTO" } } }, "PolicyContextDTO": { "type": "object", "properties": { "uuid": { "title": "Policy Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Context Name", "type": "string", "example": "Context A" }, "contextType": { "title": "ContextType", "type": "string", "example": "orgs", "enum": [ "ORGS", "PRODUCTS", "PROJECTS" ] } } }, "PolicyDTO": { "type": "object", "properties": { "uuid": { "title": "Policy Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Policy Name", "type": "string", "example": "A Policy" }, "owner": { "$ref": "#/components/schemas/UserInfoDTO" }, "createdAt": { "title": "Policy Creation Date", "type": "string", "format": "date-time" }, "priority": { "title": "Priority", "type": "integer", "description": "1 is the lowest priority", "format": "int32", "example": 1 }, "filter": { "$ref": "#/components/schemas/BasePolicyFilterDTO" }, "action": { "oneOf": [ { "$ref": "#/components/schemas/APPROVE" }, { "$ref": "#/components/schemas/CONDITIONS" }, { "$ref": "#/components/schemas/CREATE_ISSUE" }, { "$ref": "#/components/schemas/REASSIGN" }, { "$ref": "#/components/schemas/REJECT" } ] }, "context": { "$ref": "#/components/schemas/PolicyContextDTO" }, "enabled": { "title": "Enabled", "type": "boolean" }, "modifiedAt": { "title": "Policy Modification Date", "type": "string", "format": "date-time" }, "modifiedBy": { "title": "Policy Modified By", "type": "string", "example": "jon.smith@mail.com" }, "aggregatedPriority": { "type": "integer", "format": "int32" } }, "description": "Policies are checked by order of priority; note that 1 is the lowest priority" }, "UserInfoDTO": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "title": "User UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "User Name", "type": "string", "example": "Jon Smith" }, "email": { "title": "User Email", "type": "string", "example": "jon.smith@mail.com" }, "userType": { "title": "Type Of User", "type": "string", "example": "REGULAR", "enum": [ "REGULAR", "SERVICE", "SCAN_SUMMARY_RECEIVER" ] }, "accountStatus": { "type": "string", "enum": [ "ACTIVE", "INACTIVE", "LOCKOUT" ] } } }, "UpdatePrioritiesRequestDTO": { "required": [ "uuids" ], "type": "object", "properties": { "uuids": { "type": "array", "items": { "title": "Policy Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" } } }, "description": "Must contain all policy uuids" }, "DWRResponseCollectionPolicyDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyDTO" } } } }, "CustomAttributeValueDTO": { "type": "object", "properties": { "value": { "title": "Custom Attribute Value", "type": "string", "example": "Custom attribute value" } } }, "UpdateRiskRequestDTO": { "type": "object", "properties": { "status": { "title": "Alert Status", "type": "string", "enum": [ "ACTIVE", "IGNORED" ] }, "comment": { "title": "Alert Comment", "maxLength": 500, "type": "string", "example": "This alert is not important" }, "isViolating": { "type": "boolean" } } }, "DWRResponseBoolean": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "boolean" } } }, "ContextEntityRequestDTO": { "required": [ "name" ], "type": "object", "properties": { "name": { "title": "Entity Name", "type": "string", "example": "Entity A" } } }, "DWRResponseProjectDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/ProjectDTO" } } }, "ProjectDTO": { "type": "object", "properties": { "uuid": { "title": "Project UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Project Name", "type": "string", "example": "My Project" }, "path": { "title": "Product Name", "type": "string", "example": "My Product" }, "productName": { "title": "Product Name", "type": "string", "example": "My Product" }, "productUuid": { "title": "Product Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" } } }, "AttributionReportLibrarySettingRuleDTO": { "type": "object", "properties": { "excluded": { "type": "boolean" } } }, "DWRResponseProductDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/ProductDTO" } } }, "ProductDTO": { "type": "object", "properties": { "uuid": { "title": "Product Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Product Name", "type": "string", "example": "Product A" } } }, "UpdateWhiteListRuleRequestDTO": { "type": "object", "properties": { "regex": { "title": "White List Regex Rule", "type": "string", "example": "*aa*" }, "description": { "title": "White List Description", "type": "string", "example": "description for white list" } } }, "DWRResponseWhiteListRuleDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/WhiteListRuleDTO" } } }, "WhiteListRuleDTO": { "required": [ "regex" ], "type": "object", "properties": { "uuid": { "title": "White List UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "regexType": { "title": "WhiteList Regex Type", "type": "string", "enum": [ "BY_NAME", "BY_LIBRARY" ] }, "regex": { "title": "White List Regex Rule", "type": "string", "example": "*aa*" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "description": { "title": "White List Description", "type": "string", "example": "Sample description" } } }, "UpdateWhiteListRulesRequestDTO": { "title": "UpdateWhiteListRuleDTO", "required": [ "regex", "uuid" ], "type": "object", "properties": { "uuid": { "title": "White List UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "regex": { "title": "White List Regex Rule", "type": "string", "example": "*aa*" }, "description": { "title": "White List Description", "type": "string", "example": "description for white list" } } }, "UpdateInHouseRuleRequestDTO": { "type": "object", "properties": { "type": { "title": "InHouse Rule Regex Type", "type": "string", "example": "NAME", "enum": [ "NAME", "LIBRARY_COORDINATES", "ARTIFACT_ID" ] }, "regex": { "title": "InHouse Regex Rule", "type": "string", "example": "*aa*" }, "description": { "title": "InHouse Description", "type": "string", "example": "description for InHouse rule" }, "empty": { "type": "boolean" } } }, "DWRResponseWarningInHouseRuleDTO": { "title": "Initiates the update process for an individual In-House library rule", "type": "object", "properties": { "additionalData": { "title": "Provides warning messages for notifying about conditions related to the ", "type": "object", "description": "+ **warningMessage**: Serves as an alert to inform you about the status of the rule being updated.\nThe warning message will provide information about whether the rule already exists or if some of the rules are already present", "example": { "warningMessage": "item already exists" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/InHouseRuleDTO" } }, "description": "ddsc" }, "InHouseRuleDTO": { "required": [ "type" ], "type": "object", "properties": { "uuid": { "type": "string" }, "type": { "title": "InHouse Rule Regex Type", "type": "string", "enum": [ "NAME", "LIBRARY_COORDINATES", "ARTIFACT_ID" ] }, "regex": { "title": "InHouse Regex Rule", "type": "string", "example": ".*a*" }, "description": { "title": "InHouse Rule Description", "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "title": "Created By", "type": "string", "description": "Jon.Snow" }, "empty": { "type": "boolean" } } }, "UpdateInHouseRulesRequestDTO": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "title": "Proprietary Rule UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "type": { "title": "Proprietary Rule Regex Type", "type": "string", "example": "NAME", "enum": [ "NAME", "LIBRARY_COORDINATES", "ARTIFACT_ID" ] }, "regex": { "title": "Proprietary Regex Rule", "type": "string", "example": "*aa*" }, "description": { "title": "Proprietary Description", "type": "string", "example": "description for white list" }, "empty": { "type": "boolean" } } }, "UpdateGroupRequestDTO": { "type": "object", "properties": { "name": { "title": "Group Name", "type": "string", "example": "Group A" }, "description": { "title": "Group Description", "type": "string", "example": "Group description" } }, "description": "DTO for updating an existing group" }, "DWRResponseGroupDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/GroupDTO" } } }, "GroupDTO": { "type": "object", "properties": { "uuid": { "title": "Group UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Group Name", "type": "string", "example": "Group A" }, "description": { "title": "Group Description", "type": "string", "example": "Group description" }, "userCount": { "title": "User Count", "type": "integer", "format": "int32", "example": 22 } } }, "DWRResponseDomainDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/DomainDTO" } } }, "DomainDTO": { "title": "OrgDTO", "type": "object", "properties": { "uuid": { "title": "Org Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Org Name", "type": "string", "example": "Organization A" } } }, "AsyncProcessStatusV2DTO": { "type": "object", "properties": { "contextUuid": { "title": "contextUuid", "type": "string", "example": "caf69794-9882-4b55-82db-6b6da4fe2a26" }, "uuid": { "title": "uuid", "type": "string", "example": "caf69794-9882-4b55-82db-6b6da4fe2a92" }, "status": { "title": "status", "type": "string", "example": "PENDING", "enum": [ "PENDING", "IN_PROGRESS", "FAILED", "FAILURE", "SUCCESS" ] }, "contextType": { "title": "contextType", "type": "string", "example": "DOMAIN", "enum": [ "SYSTEM", "GLOBAL_ACCOUNT", "DOMAIN", "PRODUCT", "PROJECT", "SCAN", "UNSUPPORTED_TYPE" ] }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "processType": { "title": "processType", "type": "string", "example": "APPLY_POLICIES" }, "messageContentSha1": { "title": "messageContentSha1", "type": "string", "example": "fb4016165697cc32d0b90ccc82e3c2c846eb01b7" }, "userMail": { "type": "string", "writeOnly": true }, "requestToken": { "title": "requestToken", "type": "string", "example": "2cd6a43b" }, "userEmail": { "title": "userMail", "type": "string", "example": "sample@mail.com" } } }, "DWRResponseAsyncProcessStatusV2DTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/AsyncProcessStatusV2DTO" } } }, "GenerateUserKeyRequestDTO": { "type": "object", "properties": { "description": { "title": "UserToken Description", "type": "string", "example": "Token A" } } }, "DWRResponseUserKeyDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/UserKeyDTO" } } }, "UserKeyDTO": { "type": "object", "properties": { "uuid": { "title": "User Key UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "userUuid": { "title": "User UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "userKey": { "title": "User Key", "type": "string", "example": "8d541c7d782e4b7891ebf61e864f76cb9af75f17d4394b109f1155e88f3e86bd" }, "createdAt": { "title": "Time Of Creation", "type": "string", "format": "date-time" }, "lastUsedAt": { "title": "Last Token Usage", "type": "string", "format": "date-time" }, "description": { "title": "Token Description", "type": "string", "example": "Token A" }, "expirationDate": { "title": "Token Expiration Date", "type": "string", "format": "date-time" } } }, "CreateProjectByProductRequestDTO": { "required": [ "projectName" ], "type": "object", "properties": { "projectName": { "title": "Project Name", "type": "string", "example": "Project A" }, "projectDescription": { "title": "Project Description", "type": "string", "example": "Description for project" } } }, "DWRResponseCreatedProjectDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights on creating resources using supported endpoints.", "type": "object", "description": "+ **created**: Indicates whether the requested project was successfully created or if it already exists. \n When “true”, this signifies the project was successfully created. When “false”, this indicates the project already exists", "example": { "created": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/ProjectDTO" } } }, "ProjectListRequestDTO": { "required": [ "projectIdentifiers" ], "type": "object", "properties": { "projectIdentifiers": { "type": "array", "items": { "title": "Project Identifiers", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" } } } }, "CopyrightReferenceDTO": { "required": [ "copyright" ], "type": "object", "properties": { "type": { "title": "Copy Reference Type", "type": "string", "example": "PROJECT_HOMEPAGE", "enum": [ "TEXT_IN_FILE", "ARTIFACT_DESCRIPTOR", "PROJECT_HOMEPAGE", "USER", "UNSPECIFIED" ] }, "copyright": { "title": "Copyright", "type": "string", "example": "Copyright 2021 x greater by the end of" }, "customDisclaimer": { "title": "Copyright Custom Disclaimer", "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "textUrl": { "title": "Copyright Text Url", "type": "string" }, "startYear": { "title": "Copyright Start Year", "type": "string", "example": "2021" }, "endYear": { "title": "Copyright End Year", "type": "string", "example": "2022" }, "author": { "title": "Copyright Author", "type": "string", "example": "x greater by the end of" }, "referenceInfo": { "title": "Copyright Reference Info", "type": "string", "example": "x greater by the end of" } } }, "DWRResponseListProjectLibraryDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectLibraryDTO" } } } }, "EntityDTO": { "type": "object", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" } } }, "LibraryExtraInfoDTO": { "type": "object", "properties": { "distributionUrl": { "type": "string" }, "downloadUrl": { "type": "string" }, "releaseDate": { "type": "string", "format": "date-time" }, "packageManagerRepository": { "type": "string" }, "homePage": { "type": "string" }, "repositoryUrl": { "type": "string" }, "author": { "type": "string" } } }, "LibraryLicenseDTO": { "type": "object", "properties": { "uuid": { "title": "License UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "License Name", "type": "string", "example": "MIT" }, "assignedByUser": { "title": "Assigned By User", "type": "boolean" }, "licenseReferences": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseReferenceDTO" } } } }, "LibraryLocationDTO": { "type": "object", "properties": { "localPath": { "title": "Local Path", "type": "string", "example": "C:\\\\Users\\\\user\\\\.m2\\\\repository\\\\commons-io-1.4.jar" }, "dependencyFile": { "title": "Dependency File", "type": "string", "example": "C:\\\\GitHubRepos\\\\Pipline\\\\EUA\\\\plugins-automation\\\\fsa\\\\tests\\\\EUA\\\\Java\\\\bigProjectsMaven\\\\WST_417\\\\Data\\\\ksa\\\\ksa-web-core\\\\pom.xml" } } }, "LicenseReferenceDTO": { "type": "object", "properties": { "uuid": { "title": "License Reference UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "type": { "title": "License Reference Type", "type": "string", "example": "ARTIFACT_DESCRIPTOR" }, "liabilityReference": { "title": "License Liability Reference", "type": "string", "example": "https://repo.maven.apache.org/maven2/org/jruby/ext/posix/jna-posix/1.0.3/jna-posix-1.0.3.pom" }, "assignedBy": { "$ref": "#/components/schemas/UserInfoDTO" }, "textUrl": { "title": "License Reference Text URL", "type": "string" }, "customDisclaimer": { "title": "License Reference Custom Disclaimer", "type": "string" }, "information": { "title": "License Reference information", "type": "string", "example": "distribution=repo&remoteUrl=https://repo.maven.apache.org/maven2/org/jruby/ext/posix/jna-posix/1.0.3/jna-posix-1.0.3.pom" } } }, "NoticeDTO": { "required": [ "text" ], "type": "object", "properties": { "text": { "title": "Notice Text", "type": "string", "example": "Developed internally" }, "reference": { "title": "Notice REFERENCE", "type": "string", "example": "https://github.com/..." } } }, "ProjectLibraryDTO": { "type": "object", "properties": { "uuid": { "title": "Library UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Library Name", "type": "string", "example": "dbus-1.10.24-13.el7_6.x86_64.rpm" }, "artifactId": { "title": "Artifact Id", "type": "string", "example": "kind-of-6.0.2.tgz" }, "groupId": { "title": "Group Id", "type": "string", "example": "kind-of" }, "version": { "type": "string" }, "architecture": { "title": "Architecture", "type": "string" }, "languageVersion": { "title": "Language Version", "type": "string" }, "classifier": { "type": "string" }, "extension": { "type": "string" }, "sha1": { "title": "Sha1", "type": "string", "example": "01146b36a6218e64e58f3a8d66de5d7fc6f6d051" }, "description": { "title": "Description", "type": "string", "example": "Get the native type of a value." }, "type": { "title": "Type", "type": "string", "example": "javascript/Node.js" }, "libraryType": { "type": "string" }, "directDependency": { "title": "Direct Dependency", "type": "boolean" }, "purl": { "title": "Package Url", "type": "string", "example": "pkg:maven/commons-beanutils/commons-beanutils@1.8.0?type=jar" }, "extraInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "extraInformation": { "$ref": "#/components/schemas/LibraryExtraInfoDTO" }, "licenses": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryLicenseDTO" } }, "copyrightReferences": { "type": "array", "items": { "$ref": "#/components/schemas/CopyrightReferenceDTO" } }, "securityRisks": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityRiskDTO" } }, "noticeReference": { "$ref": "#/components/schemas/NoticeDTO" }, "proprietaryInfo": { "$ref": "#/components/schemas/ProprietaryInfoDTO" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryLocationDTO" } }, "attributionReportSettings": { "$ref": "#/components/schemas/AttributionReportLibrarySettingRuleDTO" }, "dependencyType": { "type": "string" }, "violations": { "title": "Number Of Violations", "type": "integer", "format": "int32", "example": 22 }, "workflowUuids": { "title": "Number Of Violated Workflows", "type": "array", "example": 2, "items": { "title": "Number Of Violated Workflows", "type": "string", "example": "2" } }, "violatingFindings": { "title": "Number Of Violating Findings", "type": "integer", "format": "int32", "example": 2 }, "trackedIssue": { "$ref": "#/components/schemas/TrackedIssueDTO" }, "project": { "$ref": "#/components/schemas/ProjectDTO" } } }, "ProprietaryInfoDTO": { "type": "object", "properties": { "ruleDescription": { "type": "string" }, "rulePattern": { "type": "string" }, "comment": { "type": "string" }, "userInfo": { "$ref": "#/components/schemas/UserInfoDTO" }, "proprietaryMarkType": { "type": "string", "enum": [ "BY_RULE", "BY_USER" ] } } }, "SecurityRiskDTO": { "type": "object", "properties": { "sourceUrl": { "type": "string" }, "riskFactor": { "type": "string", "enum": [ "NO_FINDINGS", "UNCONFIRMED_UNSAFE", "CONFIRMED_UNSAFE", "KNOWN_FALSE_POSITIVE" ] } } }, "TrackedIssueDTO": { "title": "Tracked Issue Information", "type": "object", "properties": { "uuid": { "type": "string" }, "issueId": { "type": "string" }, "origin": { "type": "string" }, "issueKey": { "type": "string" }, "account": { "$ref": "#/components/schemas/EntityDTO" }, "domain": { "$ref": "#/components/schemas/EntityDTO" }, "application": { "$ref": "#/components/schemas/EntityDTO" }, "project": { "$ref": "#/components/schemas/EntityDTO" }, "status": { "type": "string", "enum": [ "PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "DELETED" ] }, "issueStatus": { "type": "string" }, "failureReason": { "type": "string" }, "errorMessage": { "type": "string" }, "publicLink": { "type": "string" }, "creationDate": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "$ref": "#/components/schemas/EntityDTO" }, "ticketType": { "type": "string", "enum": [ "SECURITY", "LEGAL" ] } } }, "UserEmailRequestDTO": { "required": [ "email" ], "type": "object", "properties": { "email": { "title": "User Email", "type": "string", "example": "jon.smith@mail.com" } } }, "DWRResponseServiceUserDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/ServiceUserDTO" } } }, "ServiceUserDTO": { "type": "object", "properties": { "userKeyDTO": { "$ref": "#/components/schemas/UserKeyDTO" }, "userInfoDTO": { "$ref": "#/components/schemas/UserInfoDTO" } } }, "DWRResponseScanSummaryReceiverUserDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/ScanSummaryReceiverUserDTO" } } }, "ScanSummaryReceiverUserDTO": { "type": "object", "properties": { "userInfoDTO": { "$ref": "#/components/schemas/UserInfoDTO" } } }, "InviteUserRequestDTO": { "required": [ "email" ], "type": "object", "properties": { "email": { "title": "New User Email", "type": "string", "example": "jon.smith@mail.com" } } }, "DWRResponseUserInfoResponseDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/UserInfoResponseDTO" } } }, "UserInfoResponseDTO": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "title": "User UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "User Name", "type": "string", "example": "Jon Smith" }, "email": { "title": "User Email", "type": "string", "example": "jon.smith@mail.com" }, "userType": { "title": "Type Of User", "type": "string", "example": "REGULAR", "enum": [ "REGULAR", "SERVICE", "SCAN_SUMMARY_RECEIVER" ] }, "existsInOrg": { "type": "boolean" } } }, "UserEmailsRequestDTO": { "required": [ "userEmails" ], "type": "object", "properties": { "userEmails": { "uniqueItems": true, "type": "array", "items": { "type": "string", "example": "jon.smith@mail.com" } } } }, "DWRResponseListEnrichedUserInfoDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichedUserInfoDTO" } } } }, "EnrichedUserInfoDTO": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "title": "User UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "User Name", "type": "string", "example": "Jon Smith" }, "email": { "title": "User Email", "type": "string", "example": "jon.smith@mail.com" }, "userType": { "title": "Type Of User", "type": "string", "example": "REGULAR", "enum": [ "REGULAR", "SERVICE", "SCAN_SUMMARY_RECEIVER" ] }, "accountStatus": { "type": "string", "enum": [ "ACTIVE", "INACTIVE", "LOCKOUT" ] }, "roles": { "title": "List of Group Roles", "type": "array", "items": { "$ref": "#/components/schemas/GroupRoleDTO" } }, "activationLink": { "title": "Activation Link", "type": "string" }, "groupNames": { "title": "Associated Groups", "type": "array", "items": { "title": "Associated Groups", "type": "string" } } } }, "GroupRoleDTO": { "title": "List of Group Roles", "type": "object", "properties": { "contextToken": { "type": "string", "description": "Depending on the value of contextType, this can be:\n+ orgToken (org UUID by running Entities - Organization > Get User Organization) or Api Token (from the Mend SCA App: **Integrate** tab > **API Key**).\n+ productToken (product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**.\n+ projectToken (project UUID by running Entities - Product > Get Product Projects) or project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "example": "123e4567-e89b-12d3-a456-426655440000" }, "contextName": { "title": "Context Name", "type": "string", "example": "My Project" }, "contextType": { "type": "string", "description": "Type of entity the role will be associated with", "example": "orgs", "enum": [ "orgs", "products" ] }, "role": { "type": "string", "enum": [ "DEFAULT_APPROVER", "ADMIN", "ALERT_EMAIL_RECEIVER", "ALERTS_IGNORER", "LICENSE_AND_COPYRIGHT_ASSIGNER", "AUDITOR", "USER", "PRODUCT_INTEGRATOR", "SBOM_EXPORTER" ] } } }, "CreateUserRequestDTO": { "required": [ "email" ], "type": "object", "properties": { "name": { "title": "User Name", "type": "string", "example": "jon" }, "email": { "title": "User Email", "type": "string", "example": "jon.smith@mail.com" } } }, "DWRResponseUserInfoDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/UserInfoDTO" } } }, "CreateWhiteListRuleRequestDTO": { "required": [ "regex" ], "type": "object", "properties": { "regex": { "title": "White List Regex Rule", "type": "string", "example": "*aa*" }, "description": { "title": "White List Description", "type": "string", "example": "description for white list" } } }, "CreateWhiteListRulesRequestDTO": { "type": "object", "properties": { "rules": { "type": "array", "items": { "$ref": "#/components/schemas/CreateWhiteListRuleRequestDTO" } } } }, "DWRResponseListWhiteListRuleDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/WhiteListRuleDTO" } } } }, "CreateInHouseRuleRequestDTO": { "required": [ "regex", "type" ], "type": "object", "properties": { "type": { "title": "InHouse Rule Regex Type", "type": "string", "example": "NAME", "enum": [ "NAME", "LIBRARY_COORDINATES", "ARTIFACT_ID" ] }, "regex": { "title": "InHouse Regex Rule", "type": "string", "example": "*aa*" }, "description": { "title": "InHouse Description", "type": "string", "example": "description for inHouse rule" }, "empty": { "type": "boolean" } } }, "DWRResponseWarningListInHouseRuleDTO": { "title": "Initiates the update process for an individual In-House library rule", "type": "object", "properties": { "additionalData": { "title": "Provides warning messages for notifying about conditions related to the ", "type": "object", "description": "+ **warningMessage**: Serves as an alert to inform you about the status of the rule being updated.\nThe warning message will provide information about whether the rule already exists or if some of the rules are already present", "example": { "warningMessage": "item already exists" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/InHouseRuleDTO" } } }, "description": "ddsc" }, "CreateProjectByOrganizationRequestDTO": { "required": [ "projectName" ], "type": "object", "properties": { "projectName": { "title": "Project Name", "type": "string", "example": "Project A" }, "projectDescription": { "title": "Project Description", "type": "string", "example": "Description for project" }, "productName": { "title": "Product Name", "type": "string", "example": "Product A" } }, "description": "If product name is empty a default product will be created" }, "CreateProjectResponseDTO": { "type": "object", "properties": { "project": { "$ref": "#/components/schemas/ProjectDTO" }, "product": { "$ref": "#/components/schemas/ProductDTO" } } }, "DWRResponseCreatedCreateProjectResponseDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights on creating resources using supported endpoints.", "type": "object", "description": "+ **created**: Indicates whether the requested project was successfully created or if it already exists. \n When “true”, this signifies the project was successfully created. When “false”, this indicates the project already exists", "example": { "created": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/CreateProjectResponseDTO" } } }, "CreateProductDTO": { "required": [ "productName" ], "type": "object", "properties": { "productName": { "title": "Product Name", "type": "string", "example": "Product A" } } }, "DWRResponseCreatedProductDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights on creating resources using supported endpoints.", "type": "object", "description": "+ **created**: Indicates whether the requested project was successfully created or if it already exists. \n When “true”, this signifies the project was successfully created. When “false”, this indicates the project already exists", "example": { "created": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/ProductDTO" } } }, "DWRResponseNoticeDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/NoticeDTO" } } }, "LibraryLicenseRequestDTO": { "required": [ "assignedByUser", "licenseReferences", "uuid" ], "type": "object", "properties": { "uuid": { "title": "License UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "assignedByUser": { "title": "Assigned By User", "type": "boolean" }, "licenseReferences": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseReferenceRequestDTO" } } } }, "LicenseReferenceRequestDTO": { "required": [ "liabilityReference" ], "type": "object", "properties": { "liabilityReference": { "title": "License Liability Reference", "type": "string", "example": "www.somelink.com" }, "customDisclaimer": { "title": "Liability Reference", "type": "string" } } }, "DWRResponseLibraryLicenseDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/LibraryLicenseDTO" } } }, "CopyrightReferenceRequestDTO": { "type": "object", "properties": { "copyright": { "title": "Copyright Text", "type": "string", "example": "Copyright 2002 Landmark" }, "customDisclaimer": { "title": "Custom Disclaimer", "type": "string", "example": "a disclaimer for the copyright " }, "createdAt": { "title": "Copyright Creation Date", "type": "string", "format": "date-time" }, "startYear": { "title": "Copyright Start Year", "type": "string", "example": "2020" }, "endYear": { "title": "Copyright End Year", "type": "string", "example": "2022" }, "author": { "title": "Copyright Author", "type": "string", "example": "Cloud Conscious, LLC" } } }, "DWRResponseUserCopyrightReferenceDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/UserCopyrightReferenceDTO" } } }, "UserCopyrightReferenceDTO": { "required": [ "copyright" ], "type": "object", "properties": { "type": { "title": "Copy Reference Type", "type": "string", "example": "PROJECT_HOMEPAGE", "enum": [ "TEXT_IN_FILE", "ARTIFACT_DESCRIPTOR", "PROJECT_HOMEPAGE", "USER", "UNSPECIFIED" ] }, "copyright": { "title": "Copyright", "type": "string", "example": "Copyright 2021 x greater by the end of" }, "customDisclaimer": { "title": "Copyright Custom Disclaimer", "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "textUrl": { "title": "Copyright Text Url", "type": "string" }, "startYear": { "title": "Copyright Start Year", "type": "string", "example": "2021" }, "endYear": { "title": "Copyright End Year", "type": "string", "example": "2022" }, "author": { "title": "Copyright Author", "type": "string", "example": "x greater by the end of" }, "referenceInfo": { "title": "Copyright Reference Info", "type": "string", "example": "x greater by the end of" }, "assignedBy": { "$ref": "#/components/schemas/UserInfoDTO" } } }, "InHouseRequestDTO": { "required": [ "isInHouse" ], "type": "object", "properties": { "libraryUuids": { "type": "array", "items": { "title": "Library UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" } }, "comment": { "title": "User Comment", "type": "string", "example": "A comment" }, "isInHouse": { "title": "In House", "type": "boolean", "description": "true for marking inHouse false for unmaking" } } }, "GroupRoleRequestDTO": { "required": [ "contextToken", "contextType" ], "type": "object", "properties": { "contextToken": { "type": "string", "description": "Depending on the value of contextType, this can be:\n+ orgToken (org UUID by running Entities - Organization > Get User Organization) or Api Token (from the Mend SCA App: **Integrate** tab > **API Key**).\n+ productToken (product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**.\n+ projectToken (project UUID by running Entities - Product > Get Product Projects) or project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "example": "123e4567-e89b-12d3-a456-426655440000" }, "contextType": { "type": "string", "description": "Type of entity the role will be associated with", "example": "orgs", "enum": [ "orgs", "products" ] }, "role": { "type": "string", "enum": [ "DEFAULT_APPROVER", "ADMIN", "ALERT_EMAIL_RECEIVER", "ALERTS_IGNORER", "LICENSE_AND_COPYRIGHT_ASSIGNER", "AUDITOR", "USER", "PRODUCT_INTEGRATOR", "SBOM_EXPORTER" ] } } }, "DWRResponseGroupRoleDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/GroupRoleDTO" } } }, "CreateGroupRequestDTO": { "required": [ "description", "name" ], "type": "object", "properties": { "name": { "title": "Group Name", "type": "string", "example": "Group A" }, "description": { "title": "Group Description", "type": "string", "example": "Group description" } } }, "SessionInfo": { "type": "object", "properties": { "correlationId": { "type": "string" }, "userUuid": { "type": "string" }, "userName": { "type": "string" }, "email": { "type": "string" }, "refreshToken": { "type": "string" }, "jwtToken": { "type": "string" }, "orgName": { "title": "Organization Name", "type": "string", "example": "Organization A" }, "orgUuid": { "title": "Organization Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" } } }, "LoginModelDTO": { "required": [ "email", "userKey" ], "type": "object", "properties": { "email": { "title": "Email", "type": "string", "example": "jon.smith@mail.com" }, "orgToken": { "title": "Org Token", "type": "string", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: Integrate tab > API Key).", "example": "123e4567-e89b-12d3-a456-426655440000" }, "userKey": { "title": "User Key", "type": "string", "description": "Equivalent to a personal access token. Avoid pasting as plain text where it might be compromised. For a service user (recommended), you can find the user key in the Mend SCA App in **Admin > Users**. [Learn more](https://docs.mend.io/bundle/mend_maintenance/page/managing_service_users.html). For local testing purposes, you could also use one of your own personal user keys from your user profile page in the Mend SCA App.", "example": "***********" } }, "description": "Login Model that provides user name and password for the Login process." }, "DWRResponseSessionInfo": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/SessionInfo" } } }, "DWRResponseVulnerabilityFixSummaryInfoDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/VulnerabilityFixSummaryInfoDTO" } } }, "VulnerabilityFixInfoDTO": { "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "format": "int32", "example": 49422 }, "vulnerability": { "title": "Vulnerability Name", "type": "string", "example": "CVE-2021-42392" }, "type": { "title": "Type", "type": "string", "example": "UPGRADE_VERSION", "enum": [ "CHANGE_FILES", "PATCH", "UPGRADE_VERSION" ] }, "origin": { "title": "Origin", "type": "string", "example": "WHITESOURCE_EXPERT" }, "url": { "title": "Url", "type": "string", "example": "https://github.com/codehaus-plexus/plexus-utils/commit/f933e5e78dc2637e485447ed821fe14904f110de" }, "fixResolution": { "title": "Fix Resolution", "type": "string", "example": "3.0.24" }, "date": { "title": "Date", "type": "string", "format": "date-time" }, "message": { "title": "Message", "type": "string", "example": "Upgrade to version" }, "extraData": { "type": "string" }, "minimalFixVersionFromExtraData": { "type": "string" }, "minimalAffectedVersionFromExtraData": { "type": "string" } } }, "VulnerabilityFixSummaryInfoDTO": { "type": "object", "properties": { "vulnerability": { "type": "string", "description": "Vulnerability Name", "example": "CVE-2021-42392" }, "topRankedFix": { "$ref": "#/components/schemas/VulnerabilityFixInfoDTO" }, "allFixes": { "type": "array", "items": { "$ref": "#/components/schemas/VulnerabilityFixInfoDTO" } }, "totalUpVotes": { "type": "integer", "description": "Total Up Votes", "format": "int32", "example": 0 }, "totalDownVotes": { "type": "integer", "description": "Total Down Votes", "format": "int32", "example": 0 } } }, "DWRResponseVulnerabilityProfileDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/VulnerabilityProfileDTO" } } }, "EffectiveVulnerabilityInfoDTO": { "type": "object", "properties": { "referenceCount": { "title": "Vulnerability Reference Count", "type": "integer", "format": "int32" }, "shieldValue": { "title": "Shield Value", "type": "integer", "description": "RED(15), YELLOW(10), GREY(8), NO_SHIELD(6), GREEN(5)", "format": "int32" } } }, "ThreatAssessmentDTO": { "type": "object", "properties": { "exploitCodeMaturity": { "title": "Exploit Code Maturity", "type": "string", "example": "HIGH", "enum": [ "UNPROVEN", "POC_CODE", "FUNCTIONAL", "HIGH", "NOT_DEFINED" ] }, "epssPercentage": { "title": "Epss Percentage", "type": "number", "format": "float", "example": 0.8 } } }, "VulnerabilityProfileDTO": { "type": "object", "properties": { "name": { "title": "Vulnerability Name", "type": "string", "example": "CVE-2021-42392" }, "type": { "title": "VulnerabilityType", "type": "string", "example": "WS", "enum": [ "CVE", "WS" ] }, "description": { "title": "Vulnerability Description", "type": "string", "example": "Security vulnerability found in plexus-utils before 3.0.24. XML injection found in XmlWriterUtil.java" }, "score": { "title": "Vulnerability Score", "type": "number", "format": "float", "example": 5 }, "severity": { "title": "Vulnerability Severity", "type": "string", "example": "MEDIUM", "enum": [ "HIGH", "MEDIUM", "LOW" ] }, "publishDate": { "title": "Vulnerability Publish Date", "type": "string", "format": "date-time" }, "modifiedDate": { "title": "Vulnerability Modified Date", "type": "string", "format": "date-time" }, "vulnerabilityScoring": { "type": "array", "items": { "$ref": "#/components/schemas/VulnerabilityScoringDTO" } }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/VulnerabilityReferenceDTO" } }, "effectiveInfo": { "$ref": "#/components/schemas/EffectiveVulnerabilityInfoDTO" }, "threatAssessment": { "$ref": "#/components/schemas/ThreatAssessmentDTO" } } }, "VulnerabilityReferenceDTO": { "type": "object", "properties": { "value": { "title": "Vulnerability Reference Value", "type": "string", "example": "https://github.com/codehaus-plexus/plexus-utils/commit/f933e5e78dc2637e485447ed821fe14904f110de" }, "source": { "title": "vulnerability reference source", "type": "string", "example": "CERT" }, "url": { "title": "Vulnerability Reference Url", "type": "string", "example": "https://github.com/codehaus-plexus/plexus-utils/commit/f933e5e78dc2637e485447ed821fe14904f110de" }, "signature": { "title": "Vulnerability Reference Signature", "type": "boolean" }, "advisory": { "title": "Vulnerability Reference Advisory", "type": "boolean" }, "patch": { "title": "Vulnerability Reference Patch", "type": "boolean" } } }, "VulnerabilityScoringDTO": { "type": "object", "properties": { "score": { "title": "Vulnerability Score", "type": "number", "format": "float", "example": 5 }, "severity": { "title": "Vulnerability Severity", "type": "string", "example": "MEDIUM", "enum": [ "LOW", "HIGH", "MEDIUM" ] }, "type": { "title": "Vulnerability Score Type", "type": "string", "example": "CVSS_2", "enum": [ "CVSS_2", "CVSS_3" ] }, "scoreMetadataVector": { "title": "Score Metadata Vector", "type": "string", "example": "CVSS:3.1/AV:N/AC:L/PR:N/UI:R/S:U/C:H/I:H/A:H" }, "extraData": { "title": "Vulnerability Extra Data", "type": "object", "additionalProperties": { "title": "Vulnerability Extra Data", "type": "string" } } } }, "DWRResponseVitalsDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/VitalsDTO" } } }, "VitalsDTO": { "type": "object", "properties": { "lastScan": { "title": "Last Scan Date", "type": "string", "format": "date-time" }, "lastUserScanned": { "$ref": "#/components/schemas/UserInfoDTO" }, "requestToken": { "title": "Request Token", "type": "string", "example": "827eb16fefc040d399420b75791aa346adcba32b4386412682d0cce36a56c24e" }, "lastSourceFileMatch": { "title": "Last Source File Match", "type": "string", "format": "date-time" }, "lastScanComment": { "title": "Last Scan Comment", "type": "string", "example": "a comment" }, "projectCreationDate": { "title": "Project Creation Date", "type": "string", "format": "date-time" }, "pluginName": { "title": "Plugin Name", "type": "string", "example": "plugin:18.2.2" }, "pluginVersion": { "title": "Plugin Version", "type": "string", "example": "plugin:18.2.2" }, "extraProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "libraryCount": { "title": "Library Count", "type": "integer", "format": "int64", "example": 400 } } }, "DWRResponsePageableCollectionSourceFileInventoryDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/SourceFileInventoryDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "DescriptionAndExplanationDTO": { "type": "object", "properties": { "explanation": { "title": "Explanation Link", "type": "string", "example": "http://en.wikipedia.org/wiki/Academic_Free_License" }, "indicatingText": { "title": "Indicating Text", "type": "string", "example": "1) Grant of Copyright License..." }, "description": { "title": "Description", "type": "string", "example": "Not a CopyLeft license." }, "displayText": { "title": "Display Text", "type": "string", "example": "No" } } }, "LicenseDTO": { "required": [ "name" ], "type": "object", "properties": { "uuid": { "title": "License Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Licenses", "type": "string", "example": "MIT" }, "spdxName": { "title": "Spdx Name", "type": "string", "example": "Glide" }, "type": { "title": "Type", "type": "string", "example": "OPEN_SOURCE" }, "suspected": { "title": "Suspected License", "type": "boolean" }, "osiApproved": { "title": "Approved Osi", "type": "boolean" }, "profile": { "$ref": "#/components/schemas/LicenseProfileDTO" } } }, "LicenseProfileDTO": { "type": "object", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" }, "links": { "uniqueItems": true, "type": "array", "items": { "title": "Links", "type": "string", "example": "http://www.opensource.org/licenses/AFL-3.0" } }, "copyrightRiskScore": { "$ref": "#/components/schemas/RiskScoreExplanationDTO" }, "patentAndRoyaltyRisk": { "$ref": "#/components/schemas/RiskScoreExplanationDTO" }, "royaltyFree": { "title": "Royalty Free", "type": "string", "example": "Conditional" }, "copyleft": { "$ref": "#/components/schemas/DescriptionAndExplanationDTO" }, "linking": { "$ref": "#/components/schemas/DescriptionAndExplanationDTO" }, "requiredNotices": { "type": "array", "items": { "title": "Required Notices", "type": "string", "example": "Must identify specific modifications" } } } }, "RiskScoreExplanationDTO": { "type": "object", "properties": { "explanation": { "title": "Explanation Link", "type": "string", "example": "http://en.wikipedia.org/wiki/Academic_Free_License" }, "indicatingText": { "title": "Indicating Text", "type": "string", "example": "1) Grant of Copyright License..." }, "riskScore": { "title": "Risk Score", "type": "integer", "format": "int32", "example": 39 } } }, "SourceFileInventoryDTO": { "type": "object", "properties": { "uuid": { "title": "Source File UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Source File Name", "type": "string", "example": "common.js" }, "matchType": { "title": "Match Type", "type": "string", "example": "MANUAL", "enum": [ "MANUAL", "AUTOMATIC" ] }, "sha1": { "title": "SourceFileSha1", "type": "string", "example": "e9537a5384f5a7569997e87fe639961e31b38887", "enum": [ "MANUAL", "AUTOMATIC" ] }, "localPath": { "title": "Local Path", "type": "string", "example": "C:\\Users\\" }, "lastModified": { "title": "Source File Last Modification Date", "type": "string", "format": "date-time" }, "library": { "$ref": "#/components/schemas/SourceFileLibraryDTO" }, "project": { "$ref": "#/components/schemas/ProjectDTO" }, "comment": { "title": "Source File Comment", "type": "string" }, "contextType": { "title": "Context Type", "type": "string", "example": "Organization", "enum": [ "SYSTEM", "GLOBAL_ACCOUNT", "DOMAIN", "PRODUCT", "PROJECT", "SCAN", "UNSUPPORTED_TYPE" ] } } }, "SourceFileLibraryDTO": { "type": "object", "properties": { "uuid": { "title": "Source Library UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Source Library Name", "type": "string", "example": " actionview-v0.0.1" }, "licenses": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseDTO" } }, "description": { "type": "string" } } }, "DWRResponseUserPermissionListDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/UserPermissionListDTO" } } }, "UserPermissionListDTO": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "title": "User Permissions", "type": "string", "example": "POLICIES__POLICY__VIEW" } } } }, "DWRResponseListVulnerabilityProfileDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/VulnerabilityProfileDTO" } } } }, "DWRResponseCollectionLibraryImpactDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryImpactDTO" } } } }, "LibraryImpactDTO": { "type": "object", "properties": { "libraryPath": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryImpactNodeDTO" } } } }, "LibraryImpactNodeDTO": { "type": "object", "properties": { "uuid": { "title": "Library UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Library Name", "type": "string", "example": "dbus-1.10.24-13.el7_6.x86_64.rpm" }, "order": { "title": "Library Impact Order", "type": "integer", "format": "int32" } } }, "ComponentReferencesDTO": { "title": "Component References", "type": "object", "properties": { "url": { "title": "Reference Url", "type": "string", "example": "https://www.gnupg.org/related_software/pinentry/98" }, "homePage": { "title": "Reference Home Page", "type": "string", "example": "https://www.gnupg.org/related_software/pinentry/89" }, "downloadLink": { "title": "Reference Download Link", "type": "string", "example": "https://www.gnupg.org/related_software/pinentry/09" }, "issueUrl": { "title": "Reference Issue Url", "type": "string", "example": "https://www.gnupg.org/related_software/pinentry/87" }, "pomUrl": { "title": "Reference Pom Url", "type": "string", "example": "https://www.gnupg.org/related_software/pinentry/76" }, "scmUrl": { "title": "Reference Scm Url", "type": "string", "example": "https://www.gnupg.org/related_software/pinentry/65" }, "genericPackageIndex": { "title": "Reference Generic Package Index", "type": "string", "example": "5" }, "nugetGallery": { "title": "Reference Nugget Gallery", "type": "string" }, "tags": { "title": "Reference Tags", "type": "string", "example": "Important" }, "copyright": { "title": "Reference Copyright", "type": "string", "example": "Copyright 2002-2015 g10 Code GmbH" }, "hasNotice": { "title": "Reference Has Notice", "type": "boolean", "example": false } } }, "DWRResponsePageableListDueDiligenceDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/DueDiligenceDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "DueDiligenceDTO": { "type": "object", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" }, "component": { "$ref": "#/components/schemas/LibraryComponentDTO" }, "license": { "$ref": "#/components/schemas/LicenseReferenceDTO" }, "riskScore": { "$ref": "#/components/schemas/RiskScoreExplanationDTO" }, "copyrights": { "type": "array", "items": { "title": "Copyright", "type": "string", "example": "Copyright 2010 Cloud Conscious, LLC" } }, "extraData": { "$ref": "#/components/schemas/ResourceExtraDataDTO" }, "project": { "$ref": "#/components/schemas/ProjectDTO" }, "techTags": { "type": "array", "items": { "type": "string" } }, "purl": { "type": "string" } } }, "LibraryComponentDTO": { "type": "object", "properties": { "uuid": { "title": "Component UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Component Name", "type": "string", "example": "dbus-1.10.24-13.el7_6.x86_64.rpm" }, "description": { "title": "Component Description", "type": "string", "example": "Component description" }, "componentType": { "title": "Component Type", "type": "string", "example": "Library", "enum": [ "Library" ] }, "type": { "type": "string" }, "libraryType": { "title": "Library Type", "type": "string", "example": "REDHAT_PACKAGE_MODULE" }, "directDependency": { "title": "Direct Dependency", "type": "boolean" }, "dependencyType": { "title": "Dependency Type", "type": "string", "example": "Direct / Transitive" }, "references": { "$ref": "#/components/schemas/ComponentReferencesDTO" }, "groupId": { "title": "Component Name", "type": "string", "example": "org.springframework.boot" }, "artifactId": { "title": "Component Artifact", "type": "string", "example": "spring-boot" }, "version": { "title": "Component Version", "type": "string", "example": "3.0.5" }, "dependencyFile": { "type": "string" }, "localPath": { "type": "string" } } }, "ResourceAuthorDTO": { "type": "object", "properties": { "author": { "title": "Resource Author", "type": "string", "example": "The Apache Software Foundation" }, "authorUrl": { "title": "Author URL", "type": "string", "example": "http://www.apache.org/" } } }, "ResourceExtraDataDTO": { "type": "object", "properties": { "homepage": { "title": "Home Page", "type": "string", "example": "https://api.github.com/repos/SR-dude/AvP-Wine/zipball/original" }, "authors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceAuthorDTO" } } } }, "DWRResponsePageableListLightLibraryDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/LightLibraryDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "LightLibraryDTO": { "type": "object", "properties": { "uuid": { "title": "Library UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Library Name", "type": "string", "example": "dbus-1.10.24-13.el7_6.x86_64.rpm" }, "artifactId": { "title": "Artifact Id", "type": "string", "example": "kind-of-6.0.2.tgz" }, "groupId": { "title": "Group Id", "type": "string", "example": "kind-of" }, "version": { "type": "string" }, "architecture": { "title": "Architecture", "type": "string" }, "languageVersion": { "title": "Language Version", "type": "string" }, "classifier": { "type": "string" }, "extension": { "type": "string" }, "sha1": { "title": "Sha1", "type": "string", "example": "01146b36a6218e64e58f3a8d66de5d7fc6f6d051" }, "description": { "title": "Description", "type": "string", "example": "Get the native type of a value." }, "type": { "title": "Type", "type": "string", "example": "javascript/Node.js" }, "libraryType": { "type": "string" }, "directDependency": { "title": "Direct Dependency", "type": "boolean" }, "purl": { "title": "Package Url", "type": "string", "example": "pkg:maven/commons-beanutils/commons-beanutils@1.8.0?type=jar" }, "extraInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "extraInformation": { "$ref": "#/components/schemas/LibraryExtraInfoDTO" }, "securityRisks": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityRiskDTO" } }, "noticeReference": { "$ref": "#/components/schemas/NoticeDTO" }, "proprietaryInfo": { "$ref": "#/components/schemas/ProprietaryInfoDTO" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryLocationDTO" } }, "attributionReportSettings": { "$ref": "#/components/schemas/AttributionReportLibrarySettingRuleDTO" }, "dependencyType": { "type": "string" }, "violations": { "title": "Number Of Violations", "type": "integer", "format": "int32", "example": 22 }, "workflowUuids": { "title": "Number Of Violated Workflows", "type": "array", "example": 2, "items": { "title": "Number Of Violated Workflows", "type": "string", "example": "2" } }, "violatingFindings": { "title": "Number Of Violating Findings", "type": "integer", "format": "int32", "example": 2 }, "trackedIssue": { "$ref": "#/components/schemas/TrackedIssueDTO" } } }, "DWRResponsePageableListLibraryDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "LibraryDTO": { "type": "object", "properties": { "uuid": { "title": "Library UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Library Name", "type": "string", "example": "dbus-1.10.24-13.el7_6.x86_64.rpm" }, "artifactId": { "title": "Artifact Id", "type": "string", "example": "kind-of-6.0.2.tgz" }, "groupId": { "title": "Group Id", "type": "string", "example": "kind-of" }, "version": { "type": "string" }, "architecture": { "title": "Architecture", "type": "string" }, "languageVersion": { "title": "Language Version", "type": "string" }, "classifier": { "type": "string" }, "extension": { "type": "string" }, "sha1": { "title": "Sha1", "type": "string", "example": "01146b36a6218e64e58f3a8d66de5d7fc6f6d051" }, "description": { "title": "Description", "type": "string", "example": "Get the native type of a value." }, "type": { "title": "Type", "type": "string", "example": "javascript/Node.js" }, "libraryType": { "type": "string" }, "directDependency": { "title": "Direct Dependency", "type": "boolean" }, "purl": { "title": "Package Url", "type": "string", "example": "pkg:maven/commons-beanutils/commons-beanutils@1.8.0?type=jar" }, "extraInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "extraInformation": { "$ref": "#/components/schemas/LibraryExtraInfoDTO" }, "licenses": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryLicenseDTO" } }, "copyrightReferences": { "type": "array", "items": { "$ref": "#/components/schemas/CopyrightReferenceDTO" } }, "securityRisks": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityRiskDTO" } }, "noticeReference": { "$ref": "#/components/schemas/NoticeDTO" }, "proprietaryInfo": { "$ref": "#/components/schemas/ProprietaryInfoDTO" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryLocationDTO" } }, "attributionReportSettings": { "$ref": "#/components/schemas/AttributionReportLibrarySettingRuleDTO" }, "dependencyType": { "type": "string" }, "violations": { "title": "Number Of Violations", "type": "integer", "format": "int32", "example": 22 }, "workflowUuids": { "title": "Number Of Violated Workflows", "type": "array", "example": 2, "items": { "title": "Number Of Violated Workflows", "type": "string", "example": "2" } }, "violatingFindings": { "title": "Number Of Violating Findings", "type": "integer", "format": "int32", "example": 2 }, "trackedIssue": { "$ref": "#/components/schemas/TrackedIssueDTO" } } }, "DWRResponsePageableCollectionSecurityAlertLibraryDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityAlertLibraryDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "SecurityAlertLibraryDTO": { "type": "object", "properties": { "uuid": { "type": "string" }, "name": { "type": "string" }, "component": { "$ref": "#/components/schemas/LibraryComponentDTO" }, "libraryType": { "title": "Library Type", "type": "string", "example": "BINARY", "enum": [ "BINARY, SOURCE" ] }, "severity": { "type": "string" }, "criticalNum": { "title": "Number Of Critical Vulnerabilities", "type": "integer", "format": "int32", "example": 22 }, "highNum": { "title": "Number Of High Vulnerabilities", "type": "integer", "format": "int32", "example": 22 }, "mediumNum": { "title": "Number Of MEDIUM Vulnerabilities", "type": "integer", "format": "int32", "example": 22 }, "lowNum": { "title": "Number Of Low Vulnerabilities", "type": "integer", "format": "int32", "example": 22 }, "total": { "title": "Number Of All Vulnerabilities", "type": "integer", "format": "int32", "example": 22 }, "ignoreNum": { "title": "Number Of Ignored Vulnerabilities", "type": "integer", "format": "int32", "example": 22 }, "effective": { "title": "Effective Value", "type": "string", "enum": [ "RED", "YELLOW", "GREY", "NO_SHIELD", "GREEN" ] }, "detectedAt": { "title": "First Alert Detection Date", "type": "string", "format": "date-time" }, "modifiedAt": { "title": "Alert Modified Date", "type": "string", "format": "date-time" }, "publishedAt": { "title": "First Vulnerability Published Date", "type": "string", "format": "date-time" }, "lastCveUpdatedAt": { "title": "Last Vulnerability Updated Date", "type": "string", "format": "date-time" }, "subRowsIds": { "type": "array", "items": { "title": "Vulnerability Names", "type": "string", "example": "cev-2020-234" } }, "project": { "$ref": "#/components/schemas/ProjectDTO" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "status": { "type": "string", "enum": [ "ACTIVE", "IGNORED", "LIBRARY_REMOVED", "LIBRARY_IN_HOUSE", "LIBRARY_WHITELIST" ] }, "comment": { "title": "Comment on suppressed library", "type": "string", "example": "no time to fix" }, "directName": { "type": "string" }, "lastScan": { "type": "string", "format": "date-time" }, "transitiveDependency": { "title": "Transitive Dependency", "type": "boolean", "example": true }, "exploitCodeMaturity": { "type": "array", "items": { "title": "Exploit Code Maturity List", "type": "string", "example": "HIGH, POC_CODE", "enum": [ "UNPROVEN", "POC_CODE", "FUNCTIONAL", "HIGH", "NOT_DEFINED" ] } }, "exploitable": { "title": "Is Library Exploitable", "type": "boolean", "example": true }, "numOfReachable": { "title": "Number Of Reachable Vulnerabilities", "type": "integer", "format": "int32", "example": 22 }, "numOfPotentiallyReachable": { "type": "integer", "format": "int32" }, "numOfUnreachable": { "type": "integer", "format": "int32" }, "reachability": { "title": "Effective Value", "type": "string", "example": "15", "enum": [ "RED", "YELLOW", "GREY", "NO_SHIELD", "GREEN" ] }, "numOfMalicious": { "title": "Number Of Malicious Vulnerabilities", "type": "integer", "format": "int32", "example": 22 }, "malicious": { "title": "Is Library Malicious", "type": "boolean", "example": true }, "violations": { "title": "Number Of Violations", "type": "integer", "format": "int32", "example": 22 }, "workflowUuids": { "title": "Number Of Violated Workflows", "type": "array", "example": 2, "items": { "title": "Number Of Violated Workflows", "type": "string", "example": "2" } }, "violatingFindings": { "title": "Number Of Violating Findings", "type": "integer", "format": "int32", "example": 2 } } }, "AlertInfoDTO": { "type": "object", "properties": { "status": { "title": "Alert Status", "type": "string", "enum": [ "ACTIVE", "IGNORED", "LIBRARY_REMOVED", "LIBRARY_IN_HOUSE", "LIBRARY_WHITELIST" ] }, "comment": { "$ref": "#/components/schemas/UserCommentDTO" }, "detectedAt": { "title": "Alert Detection Date", "type": "string", "format": "date-time" }, "modifiedAt": { "title": "Alert Modification Date", "type": "string", "format": "date-time" } } }, "AlertIntegrationDTO": { "type": "object", "properties": { "status": { "title": "Risk Integration Status", "type": "string", "example": "SUCCESS", "enum": [ "SUCCESS", "FAILURE", "PROCESSING" ] }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/IssueTrackerDTO" } } } }, "BaseLocationComponentDTO": { "type": "object", "properties": { "uuid": { "title": "Component UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Component Name", "type": "string", "example": "dbus-1.10.24-13.el7_6.x86_64.rpm" }, "description": { "title": "Component Description", "type": "string", "example": "Component description" }, "componentType": { "type": "string" }, "type": { "type": "string" }, "libraryType": { "title": "Library Type", "type": "string", "example": "REDHAT_PACKAGE_MODULE" }, "directDependency": { "title": "Direct Dependency", "type": "boolean" }, "dependencyType": { "title": "Dependency Type", "type": "string", "example": "Direct / Transitive" }, "references": { "$ref": "#/components/schemas/ComponentReferencesDTO" }, "groupId": { "title": "Component Name", "type": "string", "example": "org.springframework.boot" }, "artifactId": { "title": "Component Artifact", "type": "string", "example": "spring-boot" }, "version": { "title": "Component Version", "type": "string", "example": "3.0.5" }, "dependencyFile": { "type": "string" }, "localPath": { "type": "string" }, "libraryLocations": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryLocationDTO" } } }, "anyOf": [ { "$ref": "#/components/schemas/LibraryLocationComponentDTO" }, { "$ref": "#/components/schemas/SourceFileLocationComponentDTO" } ] }, "DWRResponsePageableCollectionSecurityAlertDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityAlertDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "IssueTrackerDTO": { "type": "object", "properties": { "issueStatus": { "title": "Issue Status", "type": "string", "example": "Open" }, "url": { "title": "Issue URL", "type": "string", "example": "www.jira.com/projectA-22" }, "issueTrackerType": { "title": "Issue Integration Type", "type": "string", "example": "Jira-cloud" }, "issueIdentifier": { "title": "Issue Identifier", "type": "string", "example": "projectA-22" } } }, "LibraryLocationComponentDTO": { "type": "object", "properties": { "uuid": { "title": "Component UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Component Name", "type": "string", "example": "dbus-1.10.24-13.el7_6.x86_64.rpm" }, "description": { "title": "Component Description", "type": "string", "example": "Component description" }, "componentType": { "title": "Component Type", "type": "string", "example": "Library", "enum": [ "Library" ] }, "type": { "type": "string" }, "libraryType": { "title": "Library Type", "type": "string", "example": "REDHAT_PACKAGE_MODULE" }, "directDependency": { "title": "Direct Dependency", "type": "boolean" }, "dependencyType": { "title": "Dependency Type", "type": "string", "example": "Direct / Transitive" }, "references": { "$ref": "#/components/schemas/ComponentReferencesDTO" }, "groupId": { "title": "Component Name", "type": "string", "example": "org.springframework.boot" }, "artifactId": { "title": "Component Artifact", "type": "string", "example": "spring-boot" }, "version": { "title": "Component Version", "type": "string", "example": "3.0.5" }, "dependencyFile": { "type": "string" }, "localPath": { "type": "string" }, "libraryLocations": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryLocationDTO" } } } }, "SecurityAlertDTO": { "type": "object", "properties": { "uuid": { "title": "Alert Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Alert Name", "type": "string", "description": "Identifier of the alert, changes based on alert type", "example": "CVE-2021-42392" }, "type": { "type": "string", "example": "SECURITY_VULNERABILITY", "enum": [ "SECURITY_VULNERABILITY" ] }, "alertInfo": { "$ref": "#/components/schemas/AlertInfoDTO" }, "project": { "$ref": "#/components/schemas/ProjectDTO" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "component": { "$ref": "#/components/schemas/BaseLocationComponentDTO" }, "vulnerability": { "$ref": "#/components/schemas/VulnerabilityProfileDTO" }, "topFix": { "$ref": "#/components/schemas/VulnerabilityFixInfoDTO" }, "effective": { "title": "Effective Value", "type": "string", "enum": [ "RED", "YELLOW", "GREY", "NO_SHIELD", "GREEN" ] }, "alertIntegration": { "$ref": "#/components/schemas/AlertIntegrationDTO" }, "threatAssessment": { "$ref": "#/components/schemas/ThreatAssessmentDTO" }, "exploitable": { "title": "Is Vulnerability Exploitable", "type": "boolean", "example": true }, "scoreMetadataVector": { "type": "string" }, "malicious": { "title": "Is Vulnerability Malicious", "type": "boolean", "example": true }, "violations": { "title": "Number Of Violations", "type": "integer", "format": "int32", "example": 22 }, "workflowUuids": { "type": "array", "items": { "type": "string" } } } }, "SourceFileLocationComponentDTO": { "type": "object", "properties": { "uuid": { "title": "Component UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Component Name", "type": "string", "example": "dbus-1.10.24-13.el7_6.x86_64.rpm" }, "description": { "title": "Component Description", "type": "string", "example": "Component description" }, "componentType": { "title": "Component Type", "type": "string", "example": "Source File", "enum": [ "Source File" ] }, "type": { "type": "string" }, "libraryType": { "title": "Library Type", "type": "string", "example": "REDHAT_PACKAGE_MODULE" }, "directDependency": { "title": "Direct Dependency", "type": "boolean" }, "dependencyType": { "title": "Dependency Type", "type": "string", "example": "Direct / Transitive" }, "references": { "$ref": "#/components/schemas/ComponentReferencesDTO" }, "groupId": { "title": "Component Name", "type": "string", "example": "org.springframework.boot" }, "artifactId": { "title": "Component Artifact", "type": "string", "example": "spring-boot" }, "version": { "title": "Component Version", "type": "string", "example": "3.0.5" }, "dependencyFile": { "type": "string" }, "localPath": { "type": "string" }, "libraryLocations": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryLocationDTO" } }, "sourceFile": { "title": "Source File Name", "type": "string", "example": "DocXMLRPCServer.py" }, "sourceFileUuid": { "title": "Source File UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" } } }, "UserCommentDTO": { "type": "object", "properties": { "comment": { "title": "Comment", "type": "string", "example": "a comment" }, "date": { "title": "comment date", "type": "string", "format": "date-time" }, "userEmail": { "title": "User Email", "type": "string", "example": "jon.smith@mail.com" }, "username": { "title": "User Email", "type": "string", "example": "jon" } } }, "BaseComponentDTO": { "type": "object", "properties": { "uuid": { "title": "Component UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Component Name", "type": "string", "example": "dbus-1.10.24-13.el7_6.x86_64.rpm" }, "description": { "title": "Component Description", "type": "string", "example": "Component description" }, "componentType": { "type": "string" }, "type": { "type": "string" }, "libraryType": { "title": "Library Type", "type": "string", "example": "REDHAT_PACKAGE_MODULE" }, "directDependency": { "title": "Direct Dependency", "type": "boolean" }, "dependencyType": { "title": "Dependency Type", "type": "string", "example": "Direct / Transitive" }, "references": { "$ref": "#/components/schemas/ComponentReferencesDTO" }, "groupId": { "title": "Component Name", "type": "string", "example": "org.springframework.boot" }, "artifactId": { "title": "Component Artifact", "type": "string", "example": "spring-boot" }, "version": { "title": "Component Version", "type": "string", "example": "3.0.5" }, "dependencyFile": { "type": "string" }, "localPath": { "type": "string" } }, "anyOf": [ { "$ref": "#/components/schemas/LibraryComponentDTO" }, { "$ref": "#/components/schemas/SourceFileComponentDTO" } ] }, "DWRResponsePageableCollectionLegalAndComplianceAlertBaseDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/LegalAndComplianceAlertBaseDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "LegalAndComplianceAlertBaseDTO": { "type": "object", "properties": { "uuid": { "title": "Alert Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Alert Name", "type": "string", "description": "Identifier of the alert, changes based on alert type", "example": "CVE-2021-42392" }, "type": { "type": "string" }, "alertInfo": { "$ref": "#/components/schemas/AlertInfoDTO" }, "project": { "$ref": "#/components/schemas/ProjectDTO" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "component": { "$ref": "#/components/schemas/BaseComponentDTO" } }, "anyOf": [ { "$ref": "#/components/schemas/PolicyViolationAlertDTO" }, { "$ref": "#/components/schemas/NewVersionAlertDTO" }, { "$ref": "#/components/schemas/RejectedLibraryInUseAlertDTO" }, { "$ref": "#/components/schemas/MultipleLicensesAlertDTO" } ] }, "MultipleLicensesAlertDTO": { "type": "object", "properties": { "uuid": { "title": "Alert Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Alert Name", "type": "string", "description": "Identifier of the alert, changes based on alert type", "example": "CVE-2021-42392" }, "type": { "type": "string", "example": "MULTIPLE_LICENSES", "enum": [ "MULTIPLE_LICENSES" ] }, "alertInfo": { "$ref": "#/components/schemas/AlertInfoDTO" }, "project": { "$ref": "#/components/schemas/ProjectDTO" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "component": { "$ref": "#/components/schemas/BaseComponentDTO" }, "numberOfLicenses": { "title": "Number Of Licenses", "type": "integer", "format": "int32", "example": 2 }, "licenses": { "type": "array", "items": { "title": "Licenses", "type": "string", "example": "MIT" } } } }, "NewVersionAlertDTO": { "type": "object", "properties": { "uuid": { "title": "Alert Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Alert Name", "type": "string", "description": "Identifier of the alert, changes based on alert type", "example": "CVE-2021-42392" }, "type": { "type": "string", "example": "NEW_VERSION", "enum": [ "NEW_VERSION" ] }, "alertInfo": { "$ref": "#/components/schemas/AlertInfoDTO" }, "project": { "$ref": "#/components/schemas/ProjectDTO" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "component": { "$ref": "#/components/schemas/BaseComponentDTO" }, "availableVersion": { "title": "Available Version", "type": "string", "example": "2.0.0" }, "availableVersionType": { "title": "Version Type", "type": "string", "enum": [ "MAJOR", "MINOR" ] } } }, "PolicyViolationAlertDTO": { "type": "object", "properties": { "uuid": { "title": "Alert Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Alert Name", "type": "string", "description": "Identifier of the alert, changes based on alert type", "example": "CVE-2021-42392" }, "type": { "type": "string", "example": "POLICY_VIOLATIONS", "enum": [ "POLICY_VIOLATIONS" ] }, "alertInfo": { "$ref": "#/components/schemas/AlertInfoDTO" }, "project": { "$ref": "#/components/schemas/ProjectDTO" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "component": { "$ref": "#/components/schemas/BaseComponentDTO" }, "policyName": { "title": "Policy Name", "type": "string", "example": "My Policy" } } }, "RejectedLibraryInUseAlertDTO": { "type": "object", "properties": { "uuid": { "title": "Alert Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Alert Name", "type": "string", "description": "Identifier of the alert, changes based on alert type", "example": "CVE-2021-42392" }, "type": { "type": "string", "example": "REJECTED_LIBRARY_IN_USE", "enum": [ "REJECTED_LIBRARY_IN_USE" ] }, "alertInfo": { "$ref": "#/components/schemas/AlertInfoDTO" }, "project": { "$ref": "#/components/schemas/ProjectDTO" }, "product": { "$ref": "#/components/schemas/ProductDTO" }, "component": { "$ref": "#/components/schemas/BaseComponentDTO" }, "description": { "title": "Description", "type": "string", "example": "My description" } } }, "SourceFileComponentDTO": { "type": "object", "properties": { "uuid": { "title": "Component UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Component Name", "type": "string", "example": "dbus-1.10.24-13.el7_6.x86_64.rpm" }, "description": { "title": "Component Description", "type": "string", "example": "Component description" }, "componentType": { "title": "Component Type", "type": "string", "example": "Source File", "enum": [ "Source File" ] }, "type": { "type": "string" }, "libraryType": { "title": "Library Type", "type": "string", "example": "REDHAT_PACKAGE_MODULE" }, "directDependency": { "title": "Direct Dependency", "type": "boolean" }, "dependencyType": { "title": "Dependency Type", "type": "string", "example": "Direct / Transitive" }, "references": { "$ref": "#/components/schemas/ComponentReferencesDTO" }, "groupId": { "title": "Component Name", "type": "string", "example": "org.springframework.boot" }, "artifactId": { "title": "Component Artifact", "type": "string", "example": "spring-boot" }, "version": { "title": "Component Version", "type": "string", "example": "3.0.5" }, "dependencyFile": { "type": "string" }, "localPath": { "type": "string" } } }, "DWRResponsePageableCollectionUserKeyDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/UserKeyDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "DWRResponsePageableCollectionProjectDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "DWRResponsePageableListVulnerabilityProfileDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/VulnerabilityProfileDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "DWRResponseCollectionProjectDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDTO" } } } }, "ContextEntityDTO": { "required": [ "name" ], "type": "object", "properties": { "uuid": { "title": "Context Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Context Name", "type": "string", "example": "Context A" } } }, "DWRResponseContextEntityDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/ContextEntityDTO" } } }, "DWRResponseListRolePermissionsDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/RolePermissionsDTO" } } } }, "RolePermissionsDTO": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "DEFAULT_APPROVER", "ADMIN", "ALERT_EMAIL_RECEIVER", "ALERTS_IGNORER", "LICENSE_AND_COPYRIGHT_ASSIGNER", "AUDITOR", "USER", "PRODUCT_INTEGRATOR", "SBOM_EXPORTER" ] }, "permissions": { "type": "array", "items": { "title": "User Permissions", "type": "string", "example": "POLICIES__POLICY__VIEW" } } } }, "DWRResponseListLightLibraryDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/LightLibraryDTO" } } } }, "DWRResponseEnrichedUserInfoDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/EnrichedUserInfoDTO" } } }, "DWRResponsePageableListUserInfoDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/UserInfoDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "DWRResponseScanSummaryCountDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/ScanSummaryCountDTO" } } }, "ScanSummaryCountDTO": { "type": "object", "properties": { "totalCount": { "title": "Total Scan Count", "type": "integer", "description": "Total number of all scans", "format": "int64", "example": 20 }, "agents": { "type": "array", "items": { "$ref": "#/components/schemas/ScanSummaryItemDTO" } } } }, "ScanSummaryItemDTO": { "type": "object", "properties": { "name": { "title": "Agent Name", "type": "string", "example": "unified-agent" }, "count": { "title": "Scan Count", "type": "integer", "description": "Number of scans by agent", "format": "int64", "example": 10 } } }, "DWRResponsePageableCollectionVulnrerableLibrariesByProjectCountDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/VulnrerableLibrariesByProjectCountDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "VulnrerableLibrariesByProjectCountDTO": { "type": "object", "properties": { "uuid": { "title": "Entity Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "projectName": { "title": "Project Name", "type": "string", "example": "Entity A" }, "productName": { "title": "Product Name", "type": "string", "example": "Entity B" }, "vulnerableLibraries": { "title": "Number Of Vulnerable Libraries", "type": "integer", "format": "int64", "example": 10 } } }, "DWRResponsePageableCollectionLibraryCountByProjectDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryCountByProjectDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "LibraryCountByProjectDTO": { "type": "object", "properties": { "uuid": { "title": "Project UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Project name", "type": "string", "example": "myProject" }, "numberOfLibraries": { "title": "Number of libraries in project", "type": "integer", "format": "int32", "example": 34 } } }, "DWRResponsePageableDomainSummeryInHouseLibraryPerProjectDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/DomainSummeryInHouseLibraryPerProjectDTO" } }, "description": "Provides insights into endpoint-supported pagination information" }, "DomainSummeryInHouseLibraryPerProjectDTO": { "type": "object", "properties": { "totalOrganizationCount": { "title": "Total Count of In-House Libraries in the Organization", "type": "integer", "format": "int32", "example": 34 }, "projects": { "title": "In-House Libraries per Project", "type": "array", "items": { "$ref": "#/components/schemas/LibraryInHouseCountPerProjectDTO" } } } }, "LibraryInHouseCountPerProjectDTO": { "title": "In-House Libraries per Project", "type": "object", "properties": { "uuid": { "title": "Project UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Project Name", "type": "string", "example": "myProject" }, "inHouseLibraries": { "title": "Number of In-House Libraries in Project", "type": "integer", "format": "int32", "example": 34 } } }, "DWRResponsePageableCollectionVulnerableLibrariesCountDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/VulnerableLibrariesCountDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "VulnerableLibrariesCountDTO": { "type": "object", "properties": { "uuid": { "title": "Entity Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "productName": { "title": "Product Name", "type": "string", "example": "Product A" }, "projectCount": { "title": "Project Count", "type": "integer", "format": "int64", "example": 10 }, "vulnerableLibraries": { "title": "Number of vulnerable libraries", "type": "integer", "format": "int64", "example": 10 } } }, "DWRResponsePageableCollectionLibraryCountByProductDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryCountByProductDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "LibraryCountByProductDTO": { "type": "object", "properties": { "uuid": { "title": "Product UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Product name", "type": "string", "example": "myProduct" }, "numberOfLibraries": { "title": "Number of libraries in product", "type": "integer", "format": "int32", "example": 34 } } }, "DWRResponsePageableDomainSummaryInHouseLibraryPerProductDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/DomainSummaryInHouseLibraryPerProductDTO" } }, "description": "Provides insights into endpoint-supported pagination information" }, "DomainSummaryInHouseLibraryPerProductDTO": { "type": "object", "properties": { "totalOrganizationCount": { "title": "Total Count of In-House Libraries in the Organization", "type": "integer", "format": "int64", "example": 34 }, "products": { "title": "In-House Libraries per Product", "type": "array", "items": { "$ref": "#/components/schemas/LibraryInHouseCountPerProductDTO" } } } }, "LibraryInHouseCountPerProductDTO": { "title": "In-House Libraries per Product", "type": "object", "properties": { "uuid": { "title": "Product UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Product Name", "type": "string", "example": "myProduct" }, "inHouseLibraries": { "title": "Number of In-House Libraries in Product", "type": "integer", "format": "int32", "example": 34 }, "projectCount": { "title": "Number of Projects in Product", "type": "integer", "format": "int32", "example": 34 } } }, "DWRResponseLicenseCountDto": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/LicenseCountDto" } } }, "LicenseCountDto": { "type": "object", "properties": { "totalLibraryCount": { "type": "integer", "format": "int32" }, "licenses": { "type": "array", "items": { "$ref": "#/components/schemas/LicensePerDomainCountDto" } } } }, "LicensePerDomainCountDto": { "type": "object", "properties": { "licenseUuid": { "title": "Library UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "License Name", "type": "string", "example": "MIT" }, "spdxName": { "title": "License SPDX Name", "type": "string", "example": "MIT" }, "numberOfLibraries": { "title": "License Count Per Domain", "type": "integer", "format": "int64", "example": 100 } } }, "DWRResponseLibraryLanguageCountDto": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/LibraryLanguageCountDto" } } }, "LibraryLanguageCountDto": { "type": "object", "properties": { "languages": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryLanguageTypeCountDto" } } } }, "LibraryLanguageTypeCountDto": { "type": "object", "properties": { "language": { "title": "Library Language", "type": "string", "example": "Java" }, "count": { "title": "Total Count of Library language in User's Projects", "type": "integer", "format": "int64", "example": 15 } } }, "DWRResponseVulnerabilityAlertCountPerEffectiveUsageDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/VulnerabilityAlertCountPerEffectiveUsageDTO" } } }, "SecurityAlertPerVulnerabilityDTO": { "type": "object", "properties": { "total": { "title": "Total Alerts Count", "type": "integer", "format": "int32", "example": 15 }, "critical": { "title": "Critical Severity Alerts Count", "type": "integer", "format": "int32", "example": 5 }, "high": { "title": "High Severity Alerts Count", "type": "integer", "format": "int32", "example": 4 }, "medium": { "title": "Medium Severity Alerts Count", "type": "integer", "format": "int32", "example": 3 }, "low": { "title": "Low Severity Alerts Count", "type": "integer", "format": "int32", "example": 3 } } }, "VulnerabilityAlertCountPerEffectiveUsageDTO": { "type": "object", "properties": { "red": { "$ref": "#/components/schemas/SecurityAlertPerVulnerabilityDTO" }, "yellow": { "$ref": "#/components/schemas/SecurityAlertPerVulnerabilityDTO" }, "green": { "$ref": "#/components/schemas/SecurityAlertPerVulnerabilityDTO" }, "grey": { "$ref": "#/components/schemas/SecurityAlertPerVulnerabilityDTO" } } }, "DWRResponseDomainAlertTypeSummaryDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/DomainAlertTypeSummaryDTO" } } }, "DomainAlertTypeSummaryDTO": { "type": "object", "properties": { "policies": { "$ref": "#/components/schemas/PolicyCountDTO" }, "libraries": { "$ref": "#/components/schemas/LibraryCountDTO" }, "securityPerLibrary": { "$ref": "#/components/schemas/SecurityAlertPerLibraryDTO" }, "securityPerVulnerability": { "$ref": "#/components/schemas/SecurityAlertPerVulnerabilityDTO" } } }, "LibraryCountDTO": { "type": "object", "properties": { "newVersions": { "title": "New Versions Count", "type": "integer", "format": "int32", "example": 5 } } }, "PolicyCountDTO": { "type": "object", "properties": { "violations": { "title": "Policy Violations Count", "type": "integer", "format": "int32", "example": 5 } } }, "SecurityAlertPerLibraryDTO": { "type": "object", "properties": { "total": { "title": "Total Library Alerts Count", "type": "integer", "format": "int32", "example": 15 }, "librariesWithCritical": { "title": "Critical Severity Library Alerts Count", "type": "integer", "format": "int32", "example": 5 }, "librariesWithHigh": { "title": "High Severity Library Alerts Count", "type": "integer", "format": "int32", "example": 4 }, "librariesWithMedium": { "title": "Medium Severity Library Alerts Count", "type": "integer", "format": "int32", "example": 3 }, "librariesWithLow": { "title": "Low Severity Library Alerts Count", "type": "integer", "format": "int32", "example": 3 } } }, "DWRResponseSecurityAlertPerVulnerabilityDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/SecurityAlertPerVulnerabilityDTO" } } }, "DWRResponsePageableListWhiteListRuleDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/WhiteListRuleDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "DWRResponsePageableInHouseSettingsDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/InHouseSettingsDTO" } }, "description": "Provides insights into endpoint-supported pagination information" }, "InHouseSettingsDTO": { "type": "object", "properties": { "rules": { "type": "array", "items": { "$ref": "#/components/schemas/InHouseRuleDTO" } }, "active": { "type": "boolean" } } }, "DWRResponsePageableCollectionProductDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "DWRResponsePageableCollectionDomainEntitiesProductDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/DomainEntitiesProductDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "DomainEntitiesProductDTO": { "type": "object", "properties": { "uuid": { "title": "Product Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Product Name", "type": "string", "example": "Product A" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTagDTO" } }, "createdAt": { "type": "string", "format": "date-time" } } }, "EntityTagDTO": { "type": "object", "properties": { "key": { "title": "Entity Tag Key", "type": "string", "example": "key" }, "value": { "title": "Entity Tag value", "type": "string", "example": "value" } } }, "BaseVulnerabilityProfileDTO": { "type": "object", "properties": { "name": { "title": "Vulnerability Name", "type": "string", "example": "CVE-2021-42392" }, "type": { "title": "VulnerabilityType", "type": "string", "example": "WS", "enum": [ "CVE", "WS" ] }, "description": { "title": "Vulnerability Description", "type": "string", "example": "Security vulnerability found in plexus-utils before 3.0.24. XML injection found in XmlWriterUtil.java" }, "score": { "title": "Vulnerability Score", "type": "number", "format": "float", "example": 5 }, "severity": { "title": "Vulnerability Severity", "type": "string", "example": "MEDIUM", "enum": [ "HIGH", "MEDIUM", "LOW" ] }, "publishDate": { "title": "Vulnerability Publish Date", "type": "string", "format": "date-time" }, "modifiedDate": { "title": "Vulnerability Modified Date", "type": "string", "format": "date-time" } }, "oneOf": [ { "$ref": "#/components/schemas/VulnerabilityProfileDTO" } ] }, "DWRResponseLibraryVulnerabilityTrendsDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/LibraryVulnerabilityTrendsDTO" } } }, "LibraryVersionVulnerabilitiesDTO": { "type": "object", "properties": { "name": { "title": "Library Name", "type": "string", "example": "Apache Ant Core" }, "version": { "title": "Library Version", "type": "string", "example": "1.8.2" }, "type": { "title": "Library Type", "type": "string", "example": "MAVEN_ARTIFACT" }, "current": { "type": "boolean" }, "vulnerabilities": { "type": "array", "items": { "$ref": "#/components/schemas/BaseVulnerabilityProfileDTO" } } } }, "LibraryVulnerabilityTrendsDTO": { "type": "object", "properties": { "trends": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryVersionVulnerabilitiesDTO" } } } }, "DWRResponsePageableCollectionLibraryVersionDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryVersionDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "LibraryVersionDTO": { "type": "object", "properties": { "lastUpdatedAt": { "title": "Last Version Update", "type": "string", "format": "date-time" }, "version": { "title": "Version", "type": "string", "example": "original" }, "release": { "type": "string" }, "arch": { "type": "string" }, "currentVersion": { "type": "boolean" } } }, "DWRResponseListNoticeDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/NoticeDTO" } } } }, "DWRResponseNoLocationsLibraryDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/NoLocationsLibraryDTO" } } }, "NoLocationsLibraryDTO": { "type": "object", "properties": { "uuid": { "title": "Library UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Library Name", "type": "string", "example": "dbus-1.10.24-13.el7_6.x86_64.rpm" }, "artifactId": { "title": "Artifact Id", "type": "string", "example": "kind-of-6.0.2.tgz" }, "groupId": { "title": "Group Id", "type": "string", "example": "kind-of" }, "version": { "type": "string" }, "architecture": { "title": "Architecture", "type": "string" }, "languageVersion": { "title": "Language Version", "type": "string" }, "classifier": { "type": "string" }, "extension": { "type": "string" }, "sha1": { "title": "Sha1", "type": "string", "example": "01146b36a6218e64e58f3a8d66de5d7fc6f6d051" }, "description": { "title": "Description", "type": "string", "example": "Get the native type of a value." }, "type": { "title": "Type", "type": "string", "example": "javascript/Node.js" }, "libraryType": { "type": "string" }, "directDependency": { "title": "Direct Dependency", "type": "boolean" }, "purl": { "title": "Package Url", "type": "string", "example": "pkg:maven/commons-beanutils/commons-beanutils@1.8.0?type=jar" }, "extraInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "extraInformation": { "$ref": "#/components/schemas/LibraryExtraInfoDTO" }, "licenses": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryLicenseDTO" } }, "copyrightReferences": { "type": "array", "items": { "$ref": "#/components/schemas/CopyrightReferenceDTO" } }, "securityRisks": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityRiskDTO" } }, "noticeReference": { "$ref": "#/components/schemas/NoticeDTO" }, "proprietaryInfo": { "$ref": "#/components/schemas/ProprietaryInfoDTO" }, "attributionReportSettings": { "$ref": "#/components/schemas/AttributionReportLibrarySettingRuleDTO" }, "dependencyType": { "type": "string" }, "violations": { "title": "Number Of Violations", "type": "integer", "format": "int32", "example": 22 }, "workflowUuids": { "title": "Number Of Violated Workflows", "type": "array", "example": 2, "items": { "title": "Number Of Violated Workflows", "type": "string", "example": "2" } }, "violatingFindings": { "title": "Number Of Violating Findings", "type": "integer", "format": "int32", "example": 2 }, "trackedIssue": { "$ref": "#/components/schemas/TrackedIssueDTO" } } }, "DWRResponsePageableListMultipleGroupRolesPerContextDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/MultipleGroupRolesPerContextDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "MultipleGroupRolesPerContextDTO": { "required": [ "contextToken", "contextType" ], "type": "object", "properties": { "contextToken": { "type": "string", "description": "Depending on the value of contextType, this can be:\n+ orgToken (org UUID by running Entities - Organization > Get User Organization) or Api Token (from the Mend SCA App: **Integrate** tab > **API Key**).\n+ productToken (product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**.\n+ projectToken (project UUID by running Entities - Product > Get Product Projects) or project Token (from the Mend SCA App: **Integrate** tab > **Project Token**).", "example": "123e4567-e89b-12d3-a456-426655440000" }, "contextName": { "title": "Context Name", "type": "string", "example": "My Product" }, "contextType": { "type": "string", "description": "Type of entity the role will be associated with", "example": "orgs", "enum": [ "orgs", "products", "projects" ] }, "roles": { "type": "array", "items": { "title": "Role", "type": "string", "example": "ADMIN", "enum": [ "DEFAULT_APPROVER", "ADMIN", "ALERT_EMAIL_RECEIVER", "ALERTS_IGNORER", "LICENSE_AND_COPYRIGHT_ASSIGNER", "AUDITOR", "USER", "PRODUCT_INTEGRATOR", "SBOM_EXPORTER" ] } } } }, "DWRResponsePageableListGroupSummaryDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/GroupSummaryDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "GroupSummaryDTO": { "type": "object", "properties": { "uuid": { "title": "Group UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Group Name", "type": "string", "example": "Group A" }, "description": { "title": "Group Description", "type": "string", "example": "Group description" }, "users": { "title": "User Count", "type": "integer", "description": "The amount of users in that group", "format": "int32", "example": 22 }, "affectedProducts": { "title": "Affected Products", "type": "integer", "format": "int32", "example": 5 }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRoleDTO" } }, "applicationRoles": { "title": "Application roles grouped by application label", "type": "array", "items": { "$ref": "#/components/schemas/RolesGroupedByScopeDTO" } }, "applicationRolesCount": { "type": "integer", "format": "int32" }, "orgRoles": { "title": "Organization roles", "type": "array", "items": { "type": "string", "enum": [ "DEFAULT_APPROVER", "ADMIN", "ALERT_EMAIL_RECEIVER", "ALERTS_IGNORER", "LICENSE_AND_COPYRIGHT_ASSIGNER", "AUDITOR", "USER", "PRODUCT_INTEGRATOR", "SBOM_EXPORTER" ] } } } }, "RolesGroupedByScopeDTO": { "type": "object", "properties": { "label": { "title": "Group label", "type": "string", "example": "Application A" }, "roles": { "title": "Roles under this label", "type": "array", "items": { "type": "string", "enum": [ "DEFAULT_APPROVER", "ADMIN", "ALERT_EMAIL_RECEIVER", "ALERTS_IGNORER", "LICENSE_AND_COPYRIGHT_ASSIGNER", "AUDITOR", "USER", "PRODUCT_INTEGRATOR", "SBOM_EXPORTER" ] } } } }, "DWRResponsePageableCollectionDomainEntitiesDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/DomainEntitiesDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "DomainEntitiesDTO": { "type": "object", "properties": { "project": { "$ref": "#/components/schemas/DomainEntitiesProjectDTO" }, "product": { "$ref": "#/components/schemas/DomainEntitiesProductDTO" } } }, "DomainEntitiesProjectDTO": { "type": "object", "properties": { "uuid": { "title": "Project UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "name": { "title": "Project Name", "type": "string", "example": "Project A" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTagDTO" } }, "lastScanned": { "title": "Last Project Scan Date", "type": "string", "format": "date-time" }, "scannedByEmail": { "title": "Scanned By", "type": "string", "example": "jon.snow@mail.com" }, "scanComment": { "title": "Scan Comment", "type": "string", "example": "Scan comment" }, "createdAt": { "title": "Creation Date", "type": "string", "format": "date-time" } } }, "CustomAttributeDTO": { "type": "object", "properties": { "uuid": { "title": "Custom Attribute Uuid", "type": "string", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "title": "Custom Attribute Name", "type": "string", "example": "Custom Attribute" }, "description": { "title": "Custom Attribute Description", "type": "string", "example": "Custom attribute description" }, "valueType": { "title": "Value Type", "type": "string", "example": "Custom attribute value" }, "contextType": { "title": "Context Type", "type": "string", "example": "projects", "enum": [ "projects", "products", "orgs" ] } } }, "DWRResponsePageableListCustomAttributeDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "DWRResponseCollectionDomainDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDTO" } } } }, "DWRResponseLicenseDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "$ref": "#/components/schemas/LicenseDTO" } } }, "DWRResponsePageableCollectionLicenseDTO": { "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.", "example": { "totalItems": "422", "isLastPage": "true" } }, "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseDTO" } } }, "description": "Provides insights into endpoint-supported pagination information" }, "DeleteWhiteListRuleRequestDTO": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "title": "White List UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" } } }, "DeleteInHouseRuleRequestDTO": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "title": "InHouse Rule UUID", "type": "string", "example": "123e4567-e89b-12d3-a456-426655440000" }, "empty": { "type": "boolean" } } }, "DWRResponseString": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "string" } } }, "DWRResponseCollectionLibraryLicenseDTO": { "type": "object", "properties": { "supportToken": { "title": "Support Token", "type": "string", "example": "1171c60d" }, "retVal": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryLicenseDTO" } } } } }, "securitySchemes": { "bearer-key": { "type": "http", "description": "JWT token Bearer", "scheme": "bearer", "bearerFormat": "JWT" } } } }