GET Workflow Definitions Steps

The GET /WorkflowClosed A workflow is a series of steps necessary to complete a process. In the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked./Definitions/Steps method is used to retrieve the workflow definition step structure for the workflow definition steps. This method returns HTTP 200 OK on a success with information about the structure of the workflow definition steps.

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

WorkflowDefinitions: Read

Table 648: GET Workflow Definitions Steps Input Parameters

Name In Description
queryString Query

A string containing a query to limit the results (e.g. field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the APIClosed 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. for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to the Keyfactor Command Reference Guide: Using the Workflow Definitions Search Feature. The query fields supported for this endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. are DisplayName, ExtensionName, and SupportedWorkflowTypes.
pageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
returnLimit Query An integer that specifies how many results to return per page. The default is 50.
sortField Query A string containing the property by which the results should be sorted. Fields available for sorting through the API for the most part match those that appear as sortable columns in the Keyfactor Command Management Portal. The default sort field is DisplayName.
sortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.

Table 649: GET Workflow Definitions Steps Response Data

Name Description
DisplayName A string indicating the display name of the workflow definition step.
ExtensionName A string indicating the extension name of the workflow definition step. The built-in extension names are:

  • Email—Send an email message. This is a separate email message from those typically sent as part of a RequireApproval step.

  • EnrollStep—Enroll for a certificate through Keyfactor Command.

  • NOOPStep—An entry or exit step in which no operation occurs. Steps of this type indicate the start and end of the workflow.

  • PowerShell—Run a PowerShell script. The script contents are embedded within the step. It does not call out to an external file.

  • RequireApproval—Require approval for a workflow step before the step can be completed. This step includes logic to gather the correct number of approvals from the users with the correct security roles and to send an email message indicating whether the step was approved or denied. This step does not include logic to send an email initiating the approval process. Use an Email type for this.

    Important:  Workflows are not supported with CAClosed A certificate authority (CA) is an entity that issues digital certificates. Within Keyfactor Command, a CA may be a Microsoft CA or a Keyfactor gateway to a cloud-based or remote CA. delegation when they contain steps that require approval. For more information, see the CA configuration Authorization Methods Tab in the Keyfactor Command Reference Guide.

  • RestRequest—Run a REST request. The REST request contents are embedded within the step. It does not call out to an external file.

  • RevokeStep—Revoke a certificate through Keyfactor Command.
SupportedWorkflowTypes

An array containing a list of the workflow types supported by the workflow definition step. Possible built-in values are:
ConfigurationParametersDefinition

An object containing the configuration parameters for the workflow definition step. These will vary depending on the step.
SignalsDefinition An object containing the signals defined for the workflow definition step. These will vary depending on the step.
Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.