Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3
Info

NOTES:

  • API capability requires an additional WhiteSource license. Contact your CSM for more details.

  • For customers who have enabled vulnerability-based alerting, there are several changes to API version 1.3 -  refer here for details.

  • This page covers APIs for version 1.3. All version 1.3 APIs must include:

...

Code Block
        "addGlobalOrganizationPolicy",
        "addOrganizationPolicy",
        "addProductPolicy",
        "addProjectPolicy",
        "addUsersToGroups",
        "changeOriginLibrary",
        "clearOrganizationSourceFileMatchingResults",
        "clearProductSourceFileMatchingResults",
        "clearProjectSourceFileMatchingResults",
        "createGlobalOrg",
        "createGroup",
        "createProduct",
        "createProject",
        "createServiceUser",
        "createUser",
        "deleteProduct",
        "deleteProject",
        "fetchProjectPolicyIssues",
        "getAggregatedFix",
        "getAggregatedLibraryDetails",
        "getAlertsByProjectTag",
        "getAllGroups",
        "getAllOrganizations",
        "getAllProducts",
        "getAllProjects",
        "getAllUsers",
        "getChangeLogHistoryReport",
        "getChangesReport",
        "getClusterVulnerabilityReportRequest",
        "getCopyrightsTextFile",
        "getDirectDependencyVersion",
        "getGlobalLicenses",
        "getGlobalOrganizationPolicies",
        "getIntegrationActivationToken",
        "getIntegrationWorkflowRules",
        "getLibraryInfo",
        "getLibraryLicenses",
        "getLibrarySourceFiles",
        "getLibraryVulnerabilities",
        "getLicensesByPackageCoordinates",
        "getLicensesTextZip",
        "getNoticesTextFile",
        "getOrganizationAlerts",
        "getOrganizationAlertsByType",
        "getOrganizationAlertsReport",
        "getOrganizationAssignments",
        "getOrganizationAttributesReport",
        "getOrganizationBugsReport",
        "getOrganizationCapabilities",
        "getOrganizationContainerVulnerabilityReportRequest",
        "getOrganizationCustomAttributeValues",
        "getOrganizationDetails",
        "getOrganizationDueDiligenceReport",
        "getOrganizationEarlyWarningAlertReport",
        "getOrganizationEarlyWarningReport",
        "getOrganizationEffectiveLicensesReport",
        "getOrganizationEffectiveUsageAnalysis",
        "getOrganizationFileClustersReport",
        "getOrganizationIgnoredAlerts",
        "getOrganizationIgnoredAlertsReport",
        "getOrganizationInHouseLibraries",
        "getOrganizationInHouseReport",
        "getOrganizationInventoryReport",
        "getOrganizationLastModifiedProjects",
        "getOrganizationLibraryLocationReport",
        "getOrganizationLicenseAndComplianceAlertReport",
        "getOrganizationLicenseHistogram",
        "getOrganizationLicenses",
        "getOrganizationMembersReport",
        "getOrganizationPolicies",
        "getOrganizationProductTags",
        "getOrganizationProductVitals",
        "getOrganizationProjectTags",
        "getOrganizationProjectVitals",
        "getOrganizationRequestHistoryReport",
        "getOrganizationResolvedAlertsReport",
        "getOrganizationRiskReport",
        "getOrganizationSecurityAlertsByLibraryReport",
        "getOrganizationSecurityAlertsByVulnerabilityReport",
        "getOrganizationServiceUsers",
        "getOrganizationSourceFileInventoryReport",
        "getOrganizationVulnerabilityReport",
        "getPluginRequestHistoryReport",
        "getPolicyMatchesConfiguration",
        "getPolicyViolationHistoryReport",
        "getProductAlerts",
        "getProductAlertsByType",
        "getProductAlertsReport",
        "getProductAssignments",
        "getProductAttributesReport",
        "getProductAttributionReport",
        "getProductBugsReport",
        "getProductComparisonReport",
        "getProductCustomAttributeValues",
        "getProductDueDiligenceReport",
        "getProductEarlyWarningAlertReport",
        "getProductEarlyWarningReport",
        "getProductEffectiveLicensesReport",
        "getProductFileClustersReport",
        "getProductIgnoredAlerts",
        "getProductIgnoredAlertsReport",
        "getProductInHouseLibraries",
        "getProductInHouseReport",
        "getProductInventoryReport",
        "getProductLibraryLocationReport",
        "getProductLibraryLocations",
        "getProductLicenseAndComplianceAlertReport",
        "getProductLicenseCompatibilityReport",
        "getProductLicenseHistogram",
        "getProductLicenses",
        "getProductMembersReport",
        "getProductPolicies",
        "getProductProjectTags",
        "getProductProjectVitals",
        "getProductRequestHistoryReport",
        "getProductResolvedAlertsReport",
        "getProductRiskReport",
        "getProductSecurityAlertsByLibraryReport",
        "getProductSecurityAlertsByVulnerabilityReport",
        "getProductServiceUsers",
        "getProductSourceFileInventoryReport",
        "getProductTags",
        "getProductVulnerabilityReport",
        "getProjectAlerts",
        "getProjectAlertsByType",
        "getProjectAlertsReport",
        "getProjectAttributionReport",
        "getProjectBugsReport",
        "getProjectComparisonReport",
        "getProjectCopyrightsTextFile",
        "getProjectCustomAttributeValues",
        "getProjectDirectDependencies",
        "getProjectDueDiligenceReport",
        "getProjectEarlyWarningAlertReport",
        "getProjectEarlyWarningReport",
        "getProjectHierarchy",
        "getProjectIgnoredAlerts",
        "getProjectIgnoredAlertsReport",
        "getProjectInHouseLibraries",
        "getProjectInHouseReport",
        "getProjectInventory",
        "getProjectInventoryReport",
        "getProjectLibrariesInfo",
        "getProjectLibraryDependencies",
        "getProjectLibraryLocations",
        "getProjectLicenseAndComplianceAlertReport",
        "getProjectLicenseCompatibilityReport",
        "getProjectLicenseHistogram",
        "getProjectLicenses",
        "getProjectLicensesTextZip",
        "getProjectMembersReport",
        "getProjectPolicies",
        "getProjectRequestHistoryReport",
        "getProjectResolvedAlertsReport",
        "getProjectRiskReport",
        "getProjectSecurityAlertsByLibraryReport",
        "getProjectSecurityAlertsByVulnerabilityReport",
        "getProjectSourceFileInventoryReport",
        "getProjectState",
        "getProjectTags",
        "getProjectVitals",
        "getProjectVulnerabilityReport",
        "getRequestSchema",
        "getRequestState",
        "getServerCapabilities",
        "getSupportedRequests",
        "getVulnerabilitiesByFilename",
        "getVulnerabilitiesByHashes",
        "getVulnerabilitiesByPackageCoordinates",
        "getVulnerabilityProfiles",
        "hasBlockPolicy",
        "ignoreAlerts",
        "inviteUserToWebAdvisor",
        "inviteUsers",
        "librarySearch",
        "reassignPendingTasksAndConditions",
        "regenerateUserKey",
        "removeGlobalOrganizationPolicies",
        "removeOrganizationPolicies",
        "removeProductPolicies",
        "removeProductTag",
        "removeProjectPolicies",
        "removeProjectTag",
        "removeUserFromGroup",
        "removeUserFromOrganization",
        "renameProduct",
        "reorderGlobalOrganizationPolicyPriorities",
        "reorderOrganizationPolicyPriorities",
        "reorderProductPolicyPriorities",
        "reorderProjectPolicyPriorities",
        "saveProductTag",
        "saveProjectTag",
        "setAlertsStatus",
        "setGlobalOrganizationPolicyStates",
        "setLibraryNotice",
        "setOrganizationAssignments",
        "setOrganizationPolicyStates",
        "setProductAssignments",
        "setProductPolicyStates",
        "setProjectPolicyStates",
        "setProjectSetupNotificationConfig",
        "unmarkManualInHouseLibrary",
        "updateExternalIntegrationIssues",
        "updateGlobalOrganizationPolicy",
        "updateGlobalSamlIntegration",
        "updateMavenDependencyResolutionSettings",
        "updateOrganizationPolicy",
        "updateOrganizationSamlIntegration",
        "updateProductPolicy",
        "updateProjectPolicy"

Documentation of Supported API Requests

For documentation of API requests that relate to:

...