GET Workflow Certificates Pending

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./Certificates/Pending method is used to return a list of pending certificate 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). requests stored within Keyfactor Command for requests that require manager approval at the 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. level. Results can be limited to selected requests using filtering, and URL parameters can be used to specify paging and the level of information detail. This method returns HTTP 200 OK on a success with the specified pending certificate requests.

Note:  Certificate requests that require approval at the Keyfactor Command workflow level (see Workflow Definitions in the Keyfactor Command Reference Guide) are not managed with this endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server.. Instead, refer to the Workflow Definitions and Workflow Instances endpoints (see Workflow Definitions and Workflow Instances).
Note:  Certificate requests that require approval at the CA level are supported only for Microsort CAs and select CA gateways. This feature is not supported for EJBCA CAs. Use workflow for configuring Keyfactor Command-level approvals for EJBCA CAs (see Workflow Definitions in the Keyfactor Command Reference Guide).
Tip:  The following permissions (see Security Overview) are required to use this feature:

WorkflowManagement: Read

Table 627: GET Workflow Certificates Pending 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 the Keyfactor Command Reference Guide: Certificate Search Page. The query fields supported for this endpoint are:

  • CAHostname
  • CALogical
  • CommonName
  • Requester

  • RequestType (3 Denied, 5-Pending, 8-External Validation)

    This method only returns records of type (State) 5.

  • SubmissionDate
  • Template
Tip:  For example, for recent pending requests from requester key_service:
SubmissionDate -ge "2022-09-01T00:00:00Z" AND Requester -eq "KEYEXAMPLE\key_service"
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 CommonName.
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 628: GET Workflow Certificates Pending Response Data

Name

Description

Id

An integer indicating the reference ID in Keyfactor Command for the certificate request as stored in the Keyfactor Command database. This is not the same as the request ID issued by the CA. This maps to the KeyfactorRequestId parameter for pending certificate request approve and deny actions.
CARequestId An integer indicating the row index of the certificate request in the certificate authority.

CommonName

A string indicating the common name of the requested certificate.

DistinguishedName

A string indicating the distinguished name of the requested certificate.

SubmissionDate

The date and time at which the certificate request was received, as an ISO-8601 formatted UTC timestamp.
CertificateAuthority A string indicating the name of the certificate authority from which the certificate was requested in hostname\logical name format. For example:
corpca01.keyexample.com\\CorpIssuingCA1
Template A string indicating the name of the template used for the certificate request.
Requester A string containing the name of the identity that requested the certificate.

State

An integer indicating the request state of the certificate.

Note:  This method returns only requests with state 5 (pending).
StateString

A string indicating the request state of the certificate (e.g. Pending).

Note:  This method returns only requests with a Pending state.
Metadata An array containing the metadata fields populated for the certificate request.
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.