Overview
WhiteSource Prioritize offers users an API (getOrganizationEffectiveUsageAnalysis) enabling programmatic access to comprehensive analysis results. The API returns the analysis results (JSON) for all applicable Projects (which were scanned with WhiteSource Prioritize) in a specified Organization (by Product).
Provided below are the request and response API specifications (select sections are indented and colored for clarity).
Request (Input)
{
"requestType":"getOrganizationEffectiveUsageAnalysis",
"userKey":"user_key",
"orgToken":"organization_api_key"
}
Response (Output)
{
"analysisReportDateTime":"analysis_report_date_time",
"orgName":"org_name",
"products":{
[
"product":{
[
"productName":"name",
"projects":{
[
"Section of general library-level analysis results""project":{
"projectName":"name",
"libraries":{
[
"library":{
"name":"name",
"keyUuid":"keyUuid",
"groupId":"library_group_id",
"artifactId":"library_artifact_id",
"version":"library_version",
"sha1":"library_sha1",
"impactAnalysisStatus":"ia_status",
"impactAnalysisResult":"ia_results",
"analysisDateTime":"analysis_date_time",
"resultingShield":"resulting_shield",
"vulnerabilities":{
"Section of general vulnerability analysis results"[
"vulnerability":{
"name":"name",
"type":"vulnerability_type",
"severity":"vulnerability_severity",
"score":"cvss2_score",
"cvss3_severity":"cvss3_severity",
"cvss3_score":"cvss3_score",
"scoreMetadataVector":"scoreMetadataVector""publishDate":"vulnerability_publish_date",
"url":"url",
"description":"vulnerability_description",
"topFix":"top_fix",
"topResolutionText":"topResolutionText",
"cvss3Attributes":{
"attackVector":"attack_vector",
"attackComplexity":"attack_complexity",
"userInteraction":"user_interaction",
"privilegesRequired":"privileges_required",
"scope":"scope",
"Section of detailed vulnerability analysis results""confidentialityImpact":"confidentiality_impact",
"integrityImpact":"integrity_impact",
"availabilityImpact":"availability_impact"
}"impactAnalysis":{
"resultingShield":"resulting_shield",
"Section of vulnerability analysis reference findings""references":{
[
"entityId":"entity_id",
"refEntityId":"ref_entity_id",
"traces":{
[
"traceId":"trace_id",
"Section of vulnerability analysis trace findings""callOrder":"call_order",
"callerType":"caller_type",
"callerId":"caller_id",
"foundOriginFile":"found_origin_file",
"foundOriginLine":"found_origin_line"
]
}
]
}
}
}
]
}
}
]
}
}
]
}
]
}
]
}
}