Certificate Stores
The CertificateStores component of the Keyfactor API
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. (formerly known as the JKS A Java KeyStore (JKS) is a file containing security certificates with matching private keys. They are often used by Java-based applications for authentication and encryption. API) provides a set of methods to support management of certificate locations.
Through different remote Keyfactor orchestrators, Keyfactor Command can inventory, install, and remove certificates for each of the store types. For certain store types, additional actions are supported as well. The CertificateStores component provides a way to programmatically schedule jobs for these stores. For more information about certificate stores and their support within Keyfactor Command, see the Keyfactor Command Reference Guide and Keyfactor Command Orchestrator Installation and Configuration Guide, or contact your Keyfactor representative. The set of methods in this API component that can be used to manage certificate stores and their scheduled jobs is listed in Table 248: Certificate Stores Endpoints.
Table 248: Certificate Stores Endpoints
| Endpoint | Method | Description | |
|---|---|---|---|
| / | DELETE | Deletes multiple certificate stores specified in the request body. | DELETE Certificate Stores |
| / | GET | Returns all certificate stores with paging and option to specify detail level. | GET Certificate Stores |
| / | POST | Creates a new certificate store if valid parameters are supplied. | POST Certificate Stores |
| / | PUT | Updates an existing certificate store. | PUT Certificate Stores |
| /{id} | DELETE | Deletes a certificate store by its GUID. | DELETE Certificate Stores ID |
| /{id} | GET | Returns certificate store details for the specified certificate store. | GET Certificate Stores ID |
| /{id}/Inventory | GET | Returns certificate inventory for the specified certificate store. | GET Certificate Stores ID Inventory |
| /Server (*deprecated) | GET | Returns a list of certificate store servers. | GET Certificate Stores Server |
| /Server (*deprecated) | POST | Creates a new certificate store server. | POST Certificate Stores Server |
| /Server (*deprecated) | PUT | Updates an existing certificate store server. | PUT Certificate Stores Server |
| /Password | PUT | Updates the password for a certificate store. | PUT Certificate Stores Password |
| /DiscoveryJob | PUT | Creates a job to find certificate stores. | PUT Certificate Stores Discovery Job |
| /AssignContainer | PUT | Assigns a certificate store to a container. | PUT Certificate Stores Assign Container |
| /Approve | POST | Approves an array of pending certificate stores. | POST Certificate Stores Approve |
| /Schedule | POST | Creates an inventory schedule for a certificate store. | POST Certificate Stores Schedule |
| /Reenrollment | POST | Schedules a reenrollment of a certificate into a certificate store. | POST Certificate Stores Reenrollment |
| /Certificates/Add | POST | Configures a management job to add a certificate to one or more stores with the provided schedule. | POST Certificate Stores Certificates Add |
| /Certificates/Remove | POST | Configures a management job to remove a certificate from one or more stores with the provided schedule. | POST Certificate Stores Certificates Remove |
