DELETE Certificates Private Key
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.
Certificate permission can be granted at either the global or 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 note under CollectionId, below.
Table 219: DELETE Certificates Private Key Input Parameters
| Name | In | Description |
|---|---|---|
| ids | Body | Required. An array of Keyfactor Command reference IDs for certificates for which the associated private keys should be deleted in the form: [123,789,567] |
| 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 Permissions in the Keyfactor Command Reference Guide for more information. |
