GET Certificate Stores ID Inventory

The GET /CertificateStores/{id}/Inventory method is used to return a list of all the certificates found in the selected certificate store based on an inventory done using Keyfactor Command an approved orchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores.. The results include both end entity certificates and chain certificates found in the store. Query parameters enable control over pagination by specifying the page number and return limit and customization of sorting based on specified fields and order. This method returns HTTP 200 OK on a success with details about the certificates in the store.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/certificate_stores/read/
OR
/certificate_stores/read/#/ (where # is a reference to a specific certificate store container ID)

Permissions for certificate stores can be set at either the global or certificate store container level. See Container Permissions for more information about global vs container permissions.

Table 392: GET Certificate Stores {id} Inventory Input Parameters

Name In Description
id Path Required. A string indicating the GUID of the certificate store within Keyfactor Command.
PageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
ReturnLimit Query An integer that specifies how many results to return per page. The default is 50. Very large values can result in long processing time.
SortField Query A string containing the property by which the results should be sorted. Fields available for sorting through the API for the most part match those that appear as sortable columns in the Keyfactor Command Management Portal. The default sort field is Name.
SortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.

Table 393: GET Certificate Stores {id} Inventory Response Data

Name Description
Name A string indicating the alias for the certificate in the certificate store. The format for this varies depending on the certificate store type and whether the Overwrite flag is selected. See PFX Enrollment for more information.
Certificates

An array of objects indicating the certificates (end entity and chain) found in the certificate store.ClosedShow certificate details.
CertStoreInventoryItemId An integer indicating the Keyfactor Command reference ID of the certificate in the certificate store.
Parameters

An object containing the entry parameters associated with the certificate in the certificate store. Expected entry parameters will vary depending on the configuration of the certificate store type. See POST Certificate Store Types for more information about entry parameters.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the top of the Management Portal page next to the Log Out button.