GET Workflow Definitions Steps Extension Name

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/{extensionName} method is used to retrieve the workflow definition step structure for the step with the specified extensionName. Its primary use case is to populate the UI dialog in which step information is configured. When you are developing a custom workflow step, it can be used to confirm that the workflow step will display correctly in the UI. This method returns HTTP 200 OK on a success with information about the structure of the workflow definition step.

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

WorkflowDefinitions: Read

Table 636: GET Workflow Definitions Steps {extensionName} Input Parameters

Name In Description
extensionName Path

Required. A string indicating the extensionName of the workflow definition step to retrieve.

Use the GET /Workflow/Definitions/Steps method (see GET Workflow Definitions Steps) to retrieve a list of all the workflow definition steps to determine the extensionName.

Table 637: GET Workflow Definitions Steps {extensionName} 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.
Outputs An object containing the outputs for the workflow definition step. For the built-in steps, the only output is an indicator for the next step in the workflow.
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.