DELETE Enrollment Patterns ID

The DELETE /EnrollmentPatterns/{id} method is used to delete the enrollmentClosed 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). patterns with the specified ID. This endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. returns 204 with no content upon success.

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 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. exists for it, the workflow will complete successfully, but the resulting certificate will not be associated with the pattern.

Table 480: DELETE Enrollment Patterns {id} Input Parameters

Name In Description
Id Path

Required. A string indicating the Keyfactor Command reference ID of the enrollment pattern to delete.

Use the GET /EnrollmentPatterns method (see GET Enrollment Patterns) 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 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 workflow 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.