The POST /Event Handler Registration method is used to register an event handler (see Event Handler Registration). This method returns HTTP 200 OK on a success with details of the added event handler(s).
Tip: The following permissions (see Security Roles and Claims) are required to use this feature:
/monitoring/handlers/registration/modify/
Table 423: POST Event Handler Registration Input Parameters
| Name |
In |
Description |
|---|---|---|
| AssemblyName | Body | Required. A string containing the assembly name of the event handler to register. The handler file must be in the configured extensions directory on the machine running the Management Portal (see Application Settings: Console Tab). |
Table 424: POST Event Handler Registration Response Data
| Name | Description |
|---|---|
| id |
An integer indicating the Keyfactor Command reference ID for the event handler. |
| DisplayName | A string indicating the display name of the event handler. |
| ClassName | A string indicating the class name of the event handler (for example, CSS.CMS.Monitoring.EventHandling.Denied.DeniedLogger). |
| Enabled |
A Boolean indicating whether the event handler is enabled (true) or not (false). |
| SupportedEvents |
A string indicating which application events the event handler supports. Built-in events include:
|
Tip: See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor 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. 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 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. 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.
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 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. 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.