The GET /CertificateAuthority/AlertRecipients/CAHealthRecipients method is used to retrieve the list of recipients configured in Keyfactor Command for 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. health monitoring alerts. This method returns HTTP 200 OK on a success with the list of CA health recipients. This method has no input parameters other than the standard headers (see Endpoint Common Features).
Tip: The following permissions (see Security Roles and Claims) are required to use this feature:
/certificate_authorities/read/
Table 282: GET Certificate Authority Alert Recipients CA Health Recipients Response Body
|
Name |
Description |
|---|---|
| Id | An integer indicating the Keyfactor Command reference ID of the recipient. |
|
|
A string indicating the email address of the recipient. |
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.