PUT Certificate Collection Ordering

Note:  This endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. is not displayed in 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. Reference and Utility but does exist to match the same functionality available in the UI.

The PUT /CertificateCollection/CollectionOrdering method takes an input of an array of 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). IDs in the desired NavigatorClosed The Navigator is the Keyfactor Command left-hand (newer versions) or top (older versions) navigation menu. Certificate collections and reports can be configured to be added to the menu using user-defined Show in Navigator settings. display order and replaces the CollectionOrder value in the database for the affected collections to match the new order. This method returns HTTP 200 OK on a success with the collection IDs.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/certificates/collections/modify/

Table 401: PUT Certificate Collection Ordering Input Data

Name Description
Id Keyfactor Command reference ID of the certificate collection(s) in an array representing the desired Navigator display order.

There are no limits to how many collections can be in the request. All collection IDs must be unique in the request and all collections must exist.

Table 402: PUT Certificate Collection Ordering Response Data

Name Description
Id Keyfactor Command reference ID of the certificate collection(s) in an array matching the desired Navigator display order from the input.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor API 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 bottom of the Management Portal side menu.