PUT Certificate Collections

The PUT /CertificateCollections method is used to update an existing saved 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). of certificates. This method returns HTTP 200 OK on a success with details about the certificate collection.

Note:  Certificate collections that are configured for Certificate Entered Collection or Certificate Left Collection workflows (see Workflow Definition Operations) cannot be edited. This is done to prevent triggering a large number of entered/left workflows.
Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/certificates/collections/read/
/certificates/collections/modify/
OR
/certificates/collections/read/#/ (where # is a reference to a specific certificate collection ID)
/certificates/collections/modify/#/ (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 375: PUT Certificate Collections Input Parameters

Name In Description
ID Body Required. The Keyfactor Command reference ID for the certificate collection. The ID is automatically assigned by Keyfactor Command.

Use the GET /CertificateCollections method (see GET Certificate Collections) to locate the ID of the collection you wish to update.
Name Body Required. 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 Body Required. 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.
Query Body

Required. A string containing the search criteria for the collection.

For example:

"Query": "(IssuedDate -ge \"%TODAY-7%\" AND TemplateShortName -ne NULL) OR (IssuedDate -ge \"%TODAY-7%\" AND IssuerDN -contains \"keyexample\")"

See Certificate Search Page for querying guidelines.
DuplicationField Body

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. The default is 0. ClosedShow duplication field details.
ShowOnDashboard Body 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). The default is false.
Favorite Body A Boolean that sets whether the collection appears on the Navigator (true) or not (false). The default is false.

Table 376: PUT Certificate Collections 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.
Content

A string containing the search criteria for the collection. This field contains the same value as Query and is retained for backwards compatibility.
Query

Required. 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 workflow 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.