DELETE Enrollment Patterns ID
The DELETE /EnrollmentPatterns/{id} operation deletes the enrollment
Certificate enrollment refers to the process by which a user requests a digital certificate. The user must submit the request to a certificate authority (CA). pattern with the specified ID. On success, the operation returns 204 with no content.
Tip: The following permissions (see Security Roles and Claims) are required to use this feature:
/enrollment_pattern/modify/
Note: If an enrollment pattern is deleted (using the force option) when enrolled certificates exist for it in Keyfactor Command, certificate renewals will take place using the default enrollment pattern. If an enrollment pattern is deleted when a suspended enrollment 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. exists for it, the workflow will complete successfully, but the resulting certificate will not be associated with the pattern.
Table 517: DELETE Enrollment Patterns {id} Input Parameters
| Name | In | Description |
|---|---|---|
| Id | Path |
Required. An integer indicating the Keyfactor Command reference ID of the enrollment pattern to delete. Use the GET Enrollment Patterns operation to retrieve a list of all the enrollment patterns to determine the ID. |
| Force | Query | A Boolean indicating whether to force deletion of the enrollment pattern (True) in the case where dependent data exists for it such as enrolled certificates or active or suspended workflows. The default is False. |
Tip: See the Keyfactor API
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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended for validation, testing, and workflow development, and also serves as an interactive supplement to this API documentation. You can access it from the help menu (
) in the Management Portal.