Documentation Suite v11.0

GET Workflow Instances AssignedToMe

The GET /Workflow 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./Instances/AssignedToMe method is used to retrieve the list of initiated workflows awaiting input from the user making the API 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. request. This method returns HTTP 200 OK on a success with details about the workflow instances.

Note: If a workflow instance is initiated for a workflow definition that has more than one step requiring input (signals), a user can only provide that input (e.g. approve or deny a require approval request) at the step in the workflow instance where the workflow instance was suspended pending input. The user cannot jump ahead and provide input for future steps in the workflow that have not yet occurred.

Tip: The following permissions (see Security Roles and Claims) are required to use this feature:

/workflows/instances/read/

/workflows/instances/read/pending/

Table 792: GET Workflow Instances AssignedToMe 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 API 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: Using the Workflow Instances Search Feature. The query fields supported for this endpoint are: DefinitionId (workflow definition ID) Id (workflow instance GUID) InitiatingUserName (DOMAIN\\username) LastModified ReferenceId (workflow instance integer ID) StartDate Status Title WorkflowType
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 CurrentStepDisplayName.
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 793: GET Workflow Instances AssignedToMe Response Data

Name

Description

A string indicating the Keyfactor Command reference GUID of the workflow instance.

Status

A string indicating the current status of the workflow instance. The possible statuses are:

CanceledForRestart
Complete
Failed

Rejected
Running
Suspended

Only instances with a Status of Suspended are returned using this method.

Current Step ID

A string indicating the Keyfactor Command reference GUID of the workflow instance step.

Status Message

A string indicating the current status message for the workflow instance. Possible status messages vary and may include:

Access is denied
Awaiting # more approval(s) from approval roles.
Either the credentials are invalid, or the CA on [CA hostname] is not running
Issued
Issued. The private key was successfully retained.
Post-process Failed: [Message indicating reason for failure generally from the CA]
Pre-process failed: [Message indicating details of the failure]
Revoked
Step ‘Keyfactor-Enroll’ failed: [Message indicating details of the failure]
Step ‘Keyfactor-Revoke’ failed:[Message indicating details of the failure]
Step [custom step name] failed: [Message indicating details of the failure]
Taken Under Submission. The certificate template requires manager approval, and is marked as pending.
Workflow rejected by user with Id #.

Only instances with a StatusMessage of Awaiting # more approval(s) from approval roles. are returned using this method.

Definition

An object containing the workflow definition. Show workflow definition details.

Name	Description
Id	A string indicating the Keyfactor Command reference GUID of the workflow definition.
Display Name	A string indicating the display name defined for the workflow definition.
Version	An integer indicating the version number of the workflow definition.
Workflow Type	A string indicating the type of workflow definition. The currently supported types are: CertificateEnteredCollection The workflow is initiated by an automated task that Keyfactor Command runs periodically against your collections to identify certificates that now meet the query criteria of the specified certificate collection. For example, when a certificate discovered on an SSL scan becomes part of the Weak Keys collection, an email message can be generated notifying the PKI administrators that a new certificate with a weak key has been discovered. CertificateLeftCollection The workflow is initiated by an automated task that Keyfactor Command runs periodically against your collections to identify certificates that no longer meet the query criteria of the specified certificate collection. For example, when a certificate in the Web Server Certificates collection disappears, a REST request can be made to open a support ticket request to investigate the removal of a web server certificate. Enrollment (Including Renewals) The workflow is initiated by enrollment for a new or renewed certificate. Steps during the workflow can be used to do things such as require manager approval for the enrollment or manipulate the subject and/or SANs for the certificate request. Revocation The workflow is initiated by revoking a certificate. Steps during the workflow can be configured to do things such as modify the revocation comment entered when the certificate is revoked, append an additional comment, and store the resulting extended comment in a metadata field.

Current Step Display Name

A string indicating the display name defined for the workflow instance step.

Current Step Unique Name

A string indicating the unique name defined for the workflow instance step. This value is unique among the steps in a particular workflow definition. It is intended to be used as a user-friendly reference ID.

Title

A string indicating a description for the action taking place in the step, made up of the InitiatingUserName (either DOMAIN\\username or Timer Service) followed by an indication of the type of action and a specific message about the action. For example:

"KEYEXAMPLE\\jsmith is enrolling for a certificate with CN=appsrvr14.keyexample.com."

"KEYEXAMPLE\\jsmith is revoking certificate with CN=appsrvr12.keyexample.com."

Last Modified

A string indicating the date and time on which the initiated instance was last updated. The instance is updated each time a step in the workflow is completed, when signals are received for a step that accepts signals (e.g. a requires approval step), or when an instance is stopped or restarted.

Start Date

A string indicating the date and time when the instance was initiated.

Reference Id

A integer indicating the Keyfactor Command reference ID for the workflow instance.

Tip: See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor API 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.

Version 11.0

On this page: