POST Certificate Stores Certificates Remove

The POST /CertificateStores/Certificates/Remove method is used to remove a certificate from one or more certificate stores. The POST request must contain an array of certificate store GUIDs and the certificate properties that identify the certificate to remove. This method returns HTTP 200 OK on a success with an array of GUIDs for the removal jobs. Use the GET /OrchestratorJobs/JobHistory method to check on the progress of the job after submission (see GET Orchestrator Jobs Job History).

Tip:  The following permissions (see Security Overview) are required to use this feature:

Certificates: Read
CertificateStoreManagement: Schedule

Permissions for certificates and certificate stores can be set at either the global or certificate 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). and certificate store container level. See Certificate Permissions and Container Permissions in the Keyfactor Command Reference Guide for more information about global vs collection and container permissions.

Table 275: POST Certificate Stores Certificates Remove Input Parameters

Name In Description
CertificateStores Body

Required. An array of certificate store GUIDs and related information to identify the certificate to remove from the certificate store(s). ClosedShow certificate store details.

For example, to remove from one IIS personal store and one NetScaler store:

"CertificateStores": [
   {
      "Alias": "MyCertificate.pfx",
      "CertificateStoreId": "fde12aa7-6643-43db-88e8-5c91c5ce78b3"
   },
   {
      "Alias": "C2107973A928859C21330E566B299CD4A0705AE8",
      "CertificateStoreId": "322e12ea-43b2-4aab-80ae-c4ad4569b4e7"
   }
]
Schedule Body

Required. The inventory schedule for the removal job. ClosedShow schedule details.
CollectionId Body

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.