POST Certificate Authority Alert Recipients CA Health Recipients

The POST /CertificateAuthority/AlertRecipients/CAHealthRecipients method is used to create new recipients to receive CAClosed 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 in Keyfactor Command. This method returns HTTP 200 OK on a success with the details of the health monitoring recipients.

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

/certificate_authorities/modify/

Table 311: POST Certificate Authority Alert Recipients CA Health Recipients Input Body

Name

In

 Description
Emails Body

Required. An object containing a set of strings with the email address of each recipient. For example:

Copy 
{
    "Emails": [
    "Recipient1@keyexample.com","Recipient3@keyexample.com"
    ]
}

Table 312: POST Certificate Authority Alert Recipients CA Health Recipients Response Body

Name

Description
Id An integer indicating the Keyfactor Command reference ID of the recipient.

Email

A string indicating the email address of the recipient.

Note:  Only recipients created with the POST request are returned in the response. Any pre-existing recipients are not included in the response.
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.