POST Workflow Certificates Approve

The POST /WorkflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store./Certificates/Approve method will attempt to approve the provided 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). request(s) 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. This method returns HTTP 200 OK on a success with details about successful, failed and denied approval 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 Roles and Claims) are required to use this feature:

/certificates/requests/manage/

Table 840: POST Workflow Certificates Approve Input Parameters

Name In Description
requestIds Body Required. An array of integers indicating the Keyfactor Command certificate request IDs for certificate requests that should be approved in the form (without parameter name):
[23,45,12]

Use the GET /Workflow/Certificates/Pending method (see GET Workflow Certificates Pending) to retrieve a list of all the certificate requests to determine the certificate request's IDs.

Table 841: POST Workflow Certificates Approve Response Data

Name

Description

Successes

An array of strings indicating the successful approval response details. ClosedShow response details.

Failures

An array of strings indicating the failed approval response details containing the information noted above for successes. Failures of this type are generally exceptions.

Denials

An array of strings indicating the approval requests that were denied containing the information noted above for successes. Denials are usually the result of insufficient user permissions required to perform the approval.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed An API is 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. 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.