GET/v1/component/identityDeprecated

Returns a list of components that have the specified component identity. This resource accepts coordinates (group, name, version) or purl, cpe, or swidTagId

Requires permission VIEW_PORTFOLIO

Deprecated! Use /api/v2/components instead.

15 parameters
pageNumberstringoptional
The page to return. To be used in conjunction with <code>pageSize</code>.
Default:1
pageSizestringoptional
Number of elements to return per page. To be used in conjunction with <code>pageNumber</code>.
Default:100
offsetstringoptional
Offset to start returning elements from. To be used in conjunction with <code>limit</code>.
limitstringoptional
Number of elements to return per page. To be used in conjunction with <code>offset</code>.
sortNamestringoptional
Name of the resource field to sort on.
sortOrderstringoptional
Ordering of items when sorting with <code>sortName</code>.
Allowed:asc, desc
groupstringoptional
The group of the component
namestringoptional
The name of the component
versionstringoptional
The version of the component
purlstringoptional
The purl of the component
cpestringoptional
The cpe of the component
swidTagIdstringoptional
The swidTagId of the component
projectstringoptional
The project the component belongs to
excludeInactiveProjectsbooleanoptional
When true, only return components from active projects
onlyLatestProjectVersionsbooleanoptional
When true, only return components from projects flagged as the latest version

3 status codes
200A list of components that have the specified component identity
authorstringoptional
authorsarray<object>optional
blake2b_256stringoptional
blake2b_384stringoptional
blake2b_512stringoptional
blake3stringoptional
childrenarray<object>optional
classifierstringrequired
Allowed:APPLICATIONFRAMEWORKLIBRARYCONTAINEROPERATING_SYSTEMDEVICEFIRMWAREFILEPLATFORMDEVICE_DRIVERMACHINE_LEARNING_MODELDATA
copyrightstringoptional
cpestringoptional
dependencyGrapharray<string>optional
descriptionstringoptional
directDependenciesstringoptional
expandDependencyGraphbooleanoptional
extensionstringoptional
externalReferencesarray<object>optional
filenamestringoptional
groupstringoptional
isInternalbooleanoptional
lastInheritedRiskScorenumberoptional
licensestringoptional
licenseExpressionstringoptional
licenseUrlstringoptional
md5stringoptional
metricsobjectoptional
namestringrequired
notesstringoptional
occurrenceCountintegeroptional
parentobjectoptional
Recursive reference to the enclosing definition.
projectobjectrequired
propertiesarray<object>optional
publisherstringoptional
purlstringoptional
purlCoordinatesstringoptional
repositoryMetaobjectoptional
resolvedLicenseobjectoptional
scopestringoptional
Allowed:REQUIREDOPTIONALEXCLUDED
sha1stringoptional
sha256stringoptional
sha384stringoptional
sha3_256stringoptional
sha3_384stringoptional
sha3_512stringoptional
sha512stringoptional
streebog_256stringoptional
streebog_512stringoptional
supplierobjectoptional
swidTagIdstringoptional
uuidstringrequired
versionstringoptional
vulnerabilitiesarray<object>optional
401Unauthorized
403Access to the requested project is forbidden
detailstringrequired
Human-readable explanation specific to this occurrence of the problem
instancestringoptional
Reference URI that identifies the specific occurrence of the problem
statusintegerrequired
HTTP status code generated by the origin server for this occurrence of the problem
titlestringrequired
Short, human-readable summary of the problem type
typestringoptional
A URI reference that identifies the problem type

Error handling

A 401 is returned: Unauthorized. A 403 is returned: Access to the requested project is forbidden.