GET Workflow Definitions Types

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/Types method is used to retrieve the workflow definition types that have been defined for use. This method returns HTTP 200 OK on a success with information about the defined workflow definition types.

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

WorkflowDefinitions: Read

Table 646: GET Workflow Definitions Types 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 section. The query field supported for this endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. is Name.
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 WorkflowType.
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 647: GET Workflow Definitions Types Response Data

Name Description
WorkflowType A string indicating the display name of the workflow type.
KeyType A string indicating the key typeClosed The key type identifies the type of key to create when creating a symmetric or asymmetric key. It references the signing algorithm and often key size (e.g. AES-256, RSA-2048, Ed25519). for the workflow. The built-in 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). and revocation workflows use Templates as the key type.
ContextParameters An object containing the tokens that the workflow type provider has the ability to replace. These will vary depending on the workflow type.
BuiltInSteps

An object containing the information about the built-in step(s) for the workflow type (e.g. the enrollment step of the enrollment type). ClosedShow step details.