diff --git a/CheckmarxPythonSDK/CxScaApiSDK/__init__.py b/CheckmarxPythonSDK/CxScaApiSDK/__init__.py index dcce5d18..cc6eddbd 100644 --- a/CheckmarxPythonSDK/CxScaApiSDK/__init__.py +++ b/CheckmarxPythonSDK/CxScaApiSDK/__init__.py @@ -72,6 +72,7 @@ get_down_stream_remediation_by_scan_id, get_scan_info_by_scan_id, get_scan_progress_by_scan_id, + get_package_vulnerability_state_and_score_actions, ) from .AccessControlAPI import AccessControlAPI diff --git a/CheckmarxPythonSDK/CxScaApiSDK/api.py b/CheckmarxPythonSDK/CxScaApiSDK/api.py index ea703c6c..531a72e2 100644 --- a/CheckmarxPythonSDK/CxScaApiSDK/api.py +++ b/CheckmarxPythonSDK/CxScaApiSDK/api.py @@ -2893,6 +2893,90 @@ def get_packages_from_inventory_by_name_and_version( ) return response + def get_package_vulnerability_state_and_score_actions( + self, scan_id: str, project_id: str, is_latest: bool, + package_name: str, package_version: str, + package_manager: str, vulnerability_id: str + ) -> Response: + """ + This is a GraphQL API + Args: + scan_id (str): + project_id (str): + is_latest (bool): + package_name (str): + package_version (str): + package_manager (str): + vulnerability_id (str): + + Returns: + example: + { + 'data': { + 'searchPackageVulnerabilityStateAndScoreActions': + { + 'actions': [ + { + 'isComment': False, + 'actionType': 'ChangeState', + 'actionValue': 'Urgent', + 'enabled': True, + 'createdAt': '2026-10-08T03:03:48.041Z', + 'previousActionValue': 'ToVerify', + 'comment': { + 'id': '00000000-0000-0000-0000-000000000000', + 'message': 'This must be fixed asap.', + 'createdOn': '2026-10-08T03:03:48.041Z', + 'userName': 'john.doe@checkmarx.com' + } + } + ] + } + } + } + """ + query = ( + "query ( " + " $scanId: UUID!," + " $projectId: String," + " $isLatest: Boolean!," + " $packageName: String," + " $packageVersion: String," + " $packageManager: String," + " $vulnerabilityId: String" + ") {" + "searchPackageVulnerabilityStateAndScoreActions (" + " scanId: $scanId," + " projectId: $projectId," + " isLatest: $isLatest," + " packageName: $packageName," + " packageVersion: $packageVersion," + " packageManager: $packageManager," + " vulnerabilityId: $vulnerabilityId" + ") {" + " actions {" + " isComment, actionType, actionValue, enabled, createdAt," + " previousActionValue, comment {" + " id, message, createdOn, userName" + " }" + " }" + "}" + "}" + ) + variables = { + "scanId": scan_id, + "projectId": project_id, + "isLatest": is_latest, + "packageName": package_name, + "packageVersion": package_version, + "packageManager": package_manager, + "vulnerabilityId": vulnerability_id + } + response = self.api_client.call_api( + "POST", self.gql_url, json={"query": query, "variables": variables} + ) + return response + def get_all_projects(project_name=None): return Sca().get_all_projects(project_name=project_name) @@ -3403,3 +3487,13 @@ def get_packages_from_inventory_by_name_and_version( return Sca().get_packages_from_inventory_by_name_and_version( package_name=package_name, package_version=package_version ) + + +def get_package_vulnerability_state_and_score_actions( + scan_id: str, project_id: str, is_latest: bool, package_name: str, + package_version: str, package_manager: str, vulnerability_id: str +) -> Response: + return Sca().get_package_vulnerability_state_and_score_actions( + scan_id, project_id, is_latest, package_name, + package_version, package_manager, vulnerability_id + )