Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
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:

...

DOC-509

  • getProductVulnerabilityReport

  • getProjectVulnerabilityReport

  • getOrganizationSourceFileInventoryReport

  • getProductSourceFileInventoryReport

  • getProjectSourceFileInventoryReport

  • getOrganizationAlertsReport

  • getProductAlertsReport

  • getProjectAlertsReport

  • getOrganizationAttributesReport

  • getProductAttributesReport

  • getOrganizationCustomAttributeValues

  • getProductCustomAttributeValues

  • getProjectCustomAttributeValues

  • getOrganizationLibraryLocationReport

  • getProductLibraryLocationReport

  • getOrganizationDueDiligenceReport

  • getProductDueDiligenceReport

  • getProjectDueDiligenceReport

  • getOrganizationEffectiveLicensesReport

  • getProductEffectiveLicensesReport

  • getOrganizationBugsReport

  • getProductBugsReport

  • getProjectBugsReport

  • getOrganizationIgnoredAlertsReport

  • getProductIgnoredAlertsReport

  • getProjectIgnoredAlertsReport

  • getOrganizationResolvedAlertsReport

  • getProductResolvedAlertsReport

  • getProjectResolvedAlertsReport

  • getOrganizationRequestHistoryReport

  • getProductRequestHistoryReport

  • getProjectRequestHistoryReport

  • getPluginRequestHistoryReport

  • getOrganizationMembersReport

  • getProductMembersReport

  • getProjectMembersReport

  • getProductComparisonReport

  • getProjectComparisonReport

  • getOrganizationInHouseReport

  • getProductInHouseReport

  • getProjectInHouseReport

  • getOrganizationPolicies

  • getChangesReport

  • getProductAttributionReport

  • getProjectAttributionReport

  • getProductPolicies

  • addOrganizationPolicy

  • addProductPolicy

  • updateOrganizationPolicy

  • updateProductPolicy

  • removeOrganizationPolicies

  • removeProductPolicies

  • reorderOrganizationPolicyPriorities

  • reorderProductPolicyPriorities

  • getLicenses

  • createUser

  • inviteUsers

  • createGroup

  • getAllGroups

  • getAllUsers

  • getOrganizationAssignments

  • getProductAssignments

  • setOrganizationAssignments

  • setProductAssignments

  • addUsersToGroups

  • removeUserFromGroup

  • removeUserFromOrganization

  • createProject

  • deleteProject

  • createProduct

  • deleteProduct

  • getProjectHierarchy

  • getProjectInventory

  • getProjectState

  • getLibrarySourceFiles

  • inviteUserToWebAdvisor

  • createServiceUser

  • changeOriginLibrary

  • Field name

    Value

    requestType

    One of the following:

    • getOrganizationAlerts

    • getOrganizationIgnoredAlerts

    • getProductAlerts

    • getProjectAlerts

    • getAlertsByProjectTag

    • getOrganizationAlertsByType

    • getProductAlertsByType

    • getProjectAlertsByType

    • getOrganizationLicenses

    • getProductLicenses

    • getProjectLicenses

    • getOrganizationEffectiveUsageAnalysis

    • getOrganizationLicenseHistogram

    • getProductLicenseHistogram

    • getProjectLicenseHistogram

    • getLicensesTextZip

    • saveProjectTag

    • getProductLibraryLocations 

    • getProjectLibraryLocations

    • getOrganizationRiskReport

    • getProductRiskReport

    • getOrganizationInventoryReport

    • getProductInventoryReport

    • getProjectInventoryReport

    • getOrganizationVulnerabilityReport

    • getOrganizationContainerVulnerabilityReport

    • getClusterVulnerabilityReport

    Jira Legacy
    showSummaryfalse
    serverSystem JIRA
    serverId724b5413-de14-3029-bdc3-ec42660dfa05
    key

    orgToken

    Your organization API key

    productToken

    A unique identifier for your product

    projectToken

    A unique identifier for your project

    alertType

    One of the following:

    • SECURITY_VULNERABILITY

    • NEW_MAJOR_VERSION

    • NEW_MINOR_VERSION

    • MULTIPLE_LIBRARY_VERSIONS

    • REJECTED_BY_POLICY_RESOURCE

    ...