The GET /Alerts/Denied/{id} method is used to retrieve details for the denied certificate request alerts with the specified ID. This method returns HTTP 200 OK on a success with details about the specified denied certificate request alert.
Table 151: GET Alerts Denied {id} Input Parameters
| Name | In | Description |
|---|---|---|
| id | Path | Required. An integer indicating the Keyfactor Command reference ID for the denied certificate request alert. Use the GET /Alerts/Denied method (see GET Alerts Denied) to retrieve a list of all the issued request alerts to determine the alert ID. |
Table 152: GET Alerts Denied {id} Response Data
| Name | Description |
|---|---|
| Id | An integer indicating the Keyfactor Command reference ID of the denied request alert. |
| DisplayName | A string indicating the display name for the denied request alert. This name appears in the denied request alerts grid in the Management Portal. |
| Subject |
A string indicating the subject for the email message that will be delivered when the alert is triggered. Tip: Substitutable special text may be used in the subject line. Substitutable special text uses a variable in the alert definition that is replaced by data from the certificate or certificate metadata at processing time. For example, you can enter {rcn} in the alert definition and each alert generated at processing time will contain the specific requested common name of the given certificate request instead of the variable {rcn}.
|
| Message |
A string indicating the email message that will be delivered when the alert is triggered. The email message is made up of regular text and substitutable special text. If desired, you can format the message body using HTML. See Table 13: Substitutable Special Text for Denied Certificate Request Alerts for a complete list of available substitutable special text strings. |
| Recipients |
An array of strings containing the recipients for the alert. Each alert can have multiple recipients. You can use specific email addresses and/or use substitutable special text to replace an email address variable with actual email addresses at processing time. Available email substitutable special text strings include:
|
| Template | An object containing information about the certificate template for which the denied request alerts will be generated. A separate alert should be configured for each template. An alert may be configured with no template, if desired. Alerts configured in this way generate alerts for all denied certificate requests.  Show template details. |
| RegisteredEventHandler | An object containing the event handler configuration for the alert, if applicable. Show event handler details. For more information about event handlers, see Using Event Handlers. |
| EventHandlerParameters |
An array of objects containing the parameters configured for use by the event handler. The type of data will vary depending on the configured handler. |
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 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. 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.