Query: allProducts

A “Product” is flexible entity, and is the basis for the Product Security lifecycle. It may represent something that a company sells (e.g. has a UPC code), a software product that your teams built internally or acquired from a vendor or open source, or a complex solution made up multiple devices. A product can have child products, and can be a hierarchy. Products are associated with Artifacts, which represent the security information about the product. The product may have a name, model number, or SKU or may have a standardized identifier (e.g. SWID, purl, or CPE).

Return Type




Args

NameTypeDescription
afterString

If this is set to the value of the _cursor field of an item, only items after that one will be included in the result. The value of the after of this query must match the one where the _cursor value has been retrieved from.

filterProductFilter
firstInt

The number of items to include in the result. If omitted, all remaining items will be included (which can cause performance problems on large collections).

orderByProductOrderBy

Specifies the how this collection should be sorted. If omitted, the result order is not specified. If cursor-based pagination is used (i.e., the after is specified or the _cursor is requested), id_ASC will be implicitly added as last sort criterion so that the sort order is deterministic.

skipInt

The number of items in the list or collection to skip. Is applied after the after argument if both are specified.


Properties

NameTypeDescription
_allInnerChildrenMeta_QueryMeta

A flattened list of children (returns a maximum of 7 layers deep).

_assetStatusesMeta_QueryMeta

All of the processing statuses associated with this product's assets

_assetsMeta_QueryMeta

Which assets this product depends on

_businessUnitsMeta_QueryMeta

The additional Groups or Business Units this product has been shared with

_childrenMeta_QueryMeta

Children or sub-products of the Product. This is the basis of a product hierarchy.

_cursorString

Provides a value that can be supplied to the after argument for pagination. Depends on the value of the orderBy argument.

_operatingSystemsMeta_QueryMeta

Operating Systems associated with the product; these may be added by users, or by automatic detection by the system

_processingStatusesMeta_QueryMeta

Any kind of processing currently occurring on the product

_revisionID

An identifier that is updated automatically on each update of this root entity (but not on relation changes)

_tagsMeta_QueryMeta

The user-assigned tags for this Product

_testsMeta_QueryMeta

All of the tests associated with this product's assets

absoluteRiskScoreFloat

The absolute risk score computed for the Product. This score is an aggregated score of all sub-products and Artifacts associated with the Product.

allInnerChildren[Product]

A flattened list of children (returns a maximum of 7 layers deep).

architectures[String]

Instruction Set Architectures (ISAs) associated with the product; these may be added by users, or by automatic detection by the system; e.g. x86, x64, ARM, Renesas, etc.

assetStatuses[ProcessingStatus]

All of the processing statuses associated with this product's assets

assets[AssetVersion]

Which assets this product depends on

businessUnits[Group]

The additional Groups or Business Units this product has been shared with

children[Product]

Children or sub-products of the Product. This is the basis of a product hierarchy.

compilers[String]

Compilers used to build the software for the product; these may be added by users, or by automatic detection by the system; e.g. GCC, Clang, etc.

createdAtDateTime

The instant this object has been created

createdByUser

The user who created this product in Finite State

ctxEntityCtx

Context contains fields that are accesible to the permissions profile. This is an internal field related to user permissions.

deletedAtDateTime

Timestamp of when this product was deleted

descriptionString

A description of the product

environmentalControlsEnvironmentalControls

Environmental controls that are used to describe the product or its environment when deployed; these values may be set by users, or by automatic detection. This is an experimental field and subject to change.

groupGroup

The group or Business Unit responsible for the Product Security or development of the Product.

iconString

URL pointing to an icon associated with this product

idID

An auto-generated string that identifies this root entity uniquely among others of the same type

imageString

URL pointing to an image of this product

nameString
operatingSystems[OperatingSystemInstance]

Operating Systems associated with the product; these may be added by users, or by automatic detection by the system

parentProduct

Parent product of this product

processingStatuses[ProcessingStatus]

Any kind of processing currently occurring on the product

productFamilyProductFamily

Product Family (e.g. Cisco Catalyst, Cisco IOS, Cisco ASA, etc.)

productIdentifiersProductIdentifiers

Product Identifiers (such as purl, CPE, SWID, UPC, GTIN) are used to link a product to known vulnerabilities, security advisories, and other product information, and generally uniquely identify a specific instance of a product. These may be added by users, or by automatic detection by the system.

programmingLanguages[String]

Programming Language(s) used to build the software for the product; these may be added by users, or by automatic detection by the system; e.g. C, C++, Java, Python, etc.

relativeRiskScoreFloat

The relative risk score computed for the Product. This score is an aggregated score of all sub-products and Artifacts associated with the Product.

securityOwnerUser

The user who is the security owner for this product (typically a member of the Product Security team).

tags[Tag]

The user-assigned tags for this Product

tests[Test]

All of the tests associated with this product's assets

updatedAtDateTime

The instant this object has been updated the last time (not including relation updates)

urlString

The URL for the product's homepage, if it has one

vendorVendor

Vendor of the product; these may be added by users, or by automatic detection by the system; e.g. Cisco, HP, etc. The Vendor may be the same company as the Organization in Finite State, or could be a third party vendor or open source community.


This page was generated: 2024-05-17