GET Certificate Collections ID

The GET /CertificateCollections/{id} method is used to retrieve details for a certificate collectionClosed The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be availble in other places in the Management Portal (e.g. expiration alerts and certain reports). with the specified ID. This method returns HTTP 200 OK on a success with details for the certificate collection.

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

Permissions for certificates can be set at either the global or certificate collection level. See Certificate Collection Permissions for more information about global vs collection permissions.

Table 377: GET Certificate Collections {id} Input Parameters

Name In Description
id Path Required. An integer indicating the ID of the certificate collection to retrieve.

Use the GET /CertificateCollections method (see GET Certificate Collections) to retrieve a list of all the certificate collections to determine the certificate collection ID.

Table 378: GET Certificate Collections {id} Response Data

Name Description
ID The Keyfactor Command reference ID for the certificate collection. The ID is automatically assigned by Keyfactor Command.
Name The name for the certificate collection. This name appears at the top of the page in the Keyfactor Command Management Portal for this collection and can be configured to appear on the Management Portal menu under Certificate Collections. It will also appear in other places within the Management Portal where you can reference certificate collections (e.g. expiration alerts and certain reports). Because it can appear on the menu and in selection dropdowns, the name should be fairly short.
Description The description for the collection. This description appears at the top of the page in the Management Portal for this collection and can be more detailed than the collection name.
Automated An internally used Keyfactor Command field.
Content

A string containing the search criteria for the collection.

DuplicationField

An integer that sets the type of de-duplication (a.k.a. ignore renewed certificate results by) to apply to the collection when using the collection in areas of Keyfactor Command that apply de-duplication (e.g. expiration alerts). For more information, see Saving Search Criteria as a Collection. ClosedShow duplication field details.
ShowOnDashboard A Boolean that sets whether the results from this collection are included on the Management Portal dashboard Certificate Counts by Collection graph (true) or not (false).
Favorite A Boolean that sets whether the collection appears on the Navigator (true) or not (false).
EstimatedCertCount An integer that is representative of the number of certificates that have been processed by theQueryItemsPopulator timer service. It is queryable but not sortable.
LastEstimated A date formatted MM/DD/YYYY hh:mm (i.e. 12/11/2023 12:45 PM) that is representative of the last time the collection was processed (i.e., the last time the QueryItemsPopulator timer service job ran).
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.