The DELETE /Certificates/PrivateKey method is used to delete the stored private key
Private keys are used in cryptography (symmetric and asymmetric) to encrypt or sign content. In asymmetric cryptography, they are used together in a key pair with a public key. The private or secret key is retained by the key's creator, making it highly secure. of each certificate ID in the list provided in the body from the Keyfactor Command platform. This endpoint An endpoint is a URL that enables the API to gain access to resources on a server. returns 204 with no content upon success.
Permissions for certificates can be set at either the global or 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). level. See Certificate Collection Permissions for more information about global vs collection permissions. See also the CollectionId input parameter A parameter or argument is a value that is passed into a function in an application., below.
Table 285: DELETE Certificates Private Key Input Parameters
| Name | In | Description |
|---|---|---|
| ids | Body | Required. An array of integers containing the Keyfactor Command reference IDs for certificates for which the associated private keys should be deleted in the form: [123,789,567] Use the GET /Certificates method (see GET Certificates) to determine the certificate IDs. |
| CollectionId | Query |
An integer specifying an optional certificate collection identifier to validate that the user executing the request has sufficient permissions to do so. If a certificate collection ID is not supplied, the user must have global permissions to complete the action. Supplying a certificate collection ID allows for a check of the user's certificate collection-level permissions to determine whether the user has sufficient permissions at a collection level to complete the action. See Certificate Collection Permissions for more information. |
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 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.Was this page helpful? Provide Feedback