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 Roles and Claims) are required to use this feature:
/certificates/collections/read/
/certificate_stores/schedule/
OR
/certificates/collections/read/#/ (where # is a reference to a specific certificate collection ID—see CollectionID, below)
/certificate_stores/schedule/#/ (where # is a reference to a specific certificate store container ID)

Permissions for certificates and certificate stores can be set at the system-wide level or with fine-grained control. You can mix these approaches—for example, applying system-wide certificate permissions alongside container-level permissions for certificate stores. See Certificate Collection Permissions and Container Permissions for more information about the differences between system-wide and more targeted permissions.

Table 438: POST Certificate Stores Certificates Remove Input Parameters

Name In Description
Certificate Stores Body

Required. An array of objects indicating the 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:

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

Required. An object indicating the inventory schedule for the removal job. ClosedShow schedule details.
Collection Id Body

An optional integer that specifies the certificate collection (CollectionId) to validate whether the user has sufficient permissions to perform the action. If a CollectionId is not provided, the user must have appropriate permissions granted system-wide or via certificate store containers.

Providing a CollectionId allows the system to check the user's permissions at the certificate collection level. Permissions are evaluated in the following order:

  1. System-wide certificate permissions
  2. Granular certificate permissions

Use either ContainerId or CollectionId, not both. If both are specified, CollectionId takes precedence, and the ContainerId is ignored (defaults to 0).

See Certificate Collection Permissions for more information.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which 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. 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 top of the Management Portal page next to the Log Out button.