Workflow Definitions

The 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. Definitions component of 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. includes operations necessary to programmatically create, edit, retrieve, and test workflow definitions. There are two types of workflow definition:

• Global

  The global workflow definitions are built into the product and cannot be deleted, though they can be modified to add workflow steps, if desired. Global workflow definitions do not have a specific associated key and apply to all requests of the workflow's type (for example, 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).) that are not otherwise handled by a custom workflow specifying a key.

• Custom

  Custom workflow definitions are any additional workflow definitions you define beyond the built-in ones. Custom workflows are associated with a specific key (for example, certificate template A certificate template defines the policies and rules that a CA uses when a request for a certificate is received. or certificate 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 available in other places in the Management Portal (for example expiration alerts and certain reports).) and each workflow only applies to requests made using that key.

All enrollment, certificate renewal, and revocation requests go through workflow even if you haven't created any workflow steps or added any custom workflow definitions. In the absence of customization, the global workflow definitions are used. Other actions, such as periodically monitoring certificate collections for changes in membership based on query criteria, can also be configured to use workflows. However, no global workflows are available for these actions.

For more information about workflows, see Workflow Definitions.

Table 1025: Workflow Definitions Operations

Endpoint	Method	Description	Link
/	GET	Returns a list of workflow definitions, without steps.	GET Workflow Definitions
/	POST	Creates a new workflow definition, without steps.	POST Workflow Definitions
/{definitionId}	GET	Returns details of the workflow definition, including steps, for the workflow with the specified GUID.	GET Workflow Definitions Definition ID
/{definitionId}	PUT	Updates the name and description of the workflow definition with the specified GUID.	PUT Workflow Definitions Definition ID
/{definitionId}	DELETE	Deletes the workflow definition with the specified GUID.	DELETE Workflow Definitions Definition ID
/{definitionId}/Publish	POST	Publishes the workflow definition with the specified GUID to activate it for use.	POST Workflow Definitions Definition ID Publish
/{definitionId}/Publish/{version}	POST	Publishes the workflow definition with the specified GUID and specified version to activate it for use.	POST Workflow Definitions Definition ID Publish Version
/{definitionId}/Steps	PUT	Updates the workflow definition with the specified GUID to add new steps or modify existing steps.	PUT Workflow Definitions Definition ID Steps
/Steps	GET	Returns information about the structure of the workflow definitions.	GET Workflow Definitions Steps
/Steps/{extensionName}	GET	Returns information about the structure of the workflow definition step with the specified name.	GET Workflow Definitions Steps Extension Name
/Types	GET	Returns a list of the defined workflow definition types.	GET Workflow Definitions Types