The Alerts Pending component of the Keyfactor API
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. includes methods necessary to create, update, retrieve, schedule, and delete alerts for certificate requests that require approval based on policy on the CA 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..
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. (see Workflow Definitions).For more information about the difference between alerting for certificate requests that require manager approval at the CA level and alerting for certificate requests that require manager approval at the Keyfactor Command workflow level, see Pending Certificate Request Alerts.
Table 207: Alerts Pending
|
Endpoint |
Method |
Description |
Link |
|---|---|---|---|
|
/Alerts/Pending/{id} |
DELETE |
Deletes a pending certificate request alert for the specified ID. | DELETE Alerts Pending ID |
|
/Alerts/Pending/{id} |
GET |
Retrieves details for a pending certificate request alert for the specified ID. |
GET Alerts Pending ID |
| /Alerts/Pending | PUT |
Updates a pending certificate request alert for a specified ID. |
PUT Alerts Pending |
|
/Alerts/Pending/Schedule |
GET |
Retrieves details of the schedule for delivery of pending certificate request alerts. |
GET Alerts Pending Schedule |
|
/Alerts/Pending/Schedule |
PUT |
Updates the schedule for delivery of pending certificate request alerts. |
PUT Alerts Pending Schedule |
|
/Alerts/Pending |
GET |
Retrieves details for all configured pending certificate request alerts. |
GET Alerts Pending |
| /Alerts/Pending | POST |
Creates a new pending certificate request alert. |
POST Alerts Pending |
| /Alerts/Pending/Test | POST | Tests all alerts | POST Alerts Pending TestAll |
| /Alerts/Pending/Test/{id} | POST | Tests specific alerts | POST Alerts Pending Test |
Was this page helpful? Provide Feedback