PUT Event Handler Registration ID

The PUT /EventHandlerRegistration/{id} method is used to update the indicated registered event handler's DisplayName or Enabled status (see Event Handler Registration). This method returns HTTP 200 OK on a success with details of the updated event handler.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/monitoring/handlers/registration/modify/

Table 533: PUT Event Handler Registration {id} Input Parameters

Name In Description
id Path

Required. An integer indicating the Keyfactor Command reference ID for the event handler.

Use the GET /EventHandlerRegistration method (see GET Event Handler Registration) to retrieve a list of all the event handlers to determine the ID.
DisplayName Body A string indicating the display name of the event handler.
Enabled Body

A Boolean indicating whether the event handler is enabled (true) or not (false).

Table 534: PUT Event Handler Registration {id} 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:

  • Certificate Expiration Handler

  • Denied Certificate Request Handler

  • Issued Certificate Handler

  • Key Rotation Handler

  • Pending Certificate Handler
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 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. 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.