GET Certificate Collections
The GET /CertificateCollections method is used to return a list of all certificate collections. This method returns HTTP 200 OK on a success with details about each defined certificate collection
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).. This method allows URL parameters to specify paging and the level of information detail.
Permissions for certificates can be set at either the global or certificate collection level. See Certificate Permissions in the Keyfactor Command Reference Guide for more information about global vs collection permissions.
Table 241: GET Certificate Collections Input Parameters
| Name | In | Description |
|---|---|---|
| queryString | Query |
A string containing a query to limit the results (e.g. field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to the Keyfactor Command Reference Guide: Certificate Search Page. The query fields supported for this endpoint are:
|
| 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. |
| 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 242: GET CertificateCollections 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 in the Keyfactor Command Reference Guide. |
| 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—on the Certificates top-level menu dropdown—(true) or not (false). |
) at the top of the Keyfactor Command Management Portal page next to the Log Out button.