Table of Contents | ||||
---|---|---|---|---|
|
Info |
---|
NOTES:
|
...
Parameter | Description |
---|---|
requestType | For details, see Supported API Requests. |
orgToken | Your organization API key. |
productToken | A unique identifier for your product. |
projectToken | A unique identifier for your project. |
...
The following characters are NOT supported as API input: <, >, % and &
Supported
...
API
...
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" |
...
Requests
For documentation of API requests that relate to:
...
/wiki/spaces/WD/pages/33816708
Alerts, see Alerts API
Groups and Users, see Groups and Users API
Reports, see Reports API
Licenses and Libraries, see Licenses and Library API
Global Orgs/Organizations/Products/Projects, see Get Alerts by Type
Global Org/Organization/Product/Project
...
Product and Project-Level APIs