POST Alerts Pending

Required. 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.

For example:

"Hello,\n\nA certificate using the {template A certificate template defines the policies and rules that a CA uses when a request for a certificate is received.} template was requested by {requester:displayname} from {careqid} on {subdate}. The certificate details include:\n\n<table>\n<tr><th>Certificate Details</th><th>Metadata</th></tr>\n<tr><td>CN A common name (CN) is the component of a distinguished name (DN) that represents the primary name of the object. The value varies depending on the type of object. For a user object, this would be the user's name (e.g. CN=John Smith). For SSL certificates, the CN is typically the fully qualified domain name (FQDN) of the host where the SSL certificate will reside (e.g. servername.keyexample.com or www.keyexample.com).: {rcn}</td><td>App Owner First Name: {metadata:AppOwnerFirstName}</td></tr>\n<tr><td>DN A distinguished name (DN) is the name that uniquely identifies an object in a directory. In the context of Keyfactor Command, this directory is generally Active Directory. A DN is made up of attribute=value pairs, separated by commas. Any of the attributes defined in the directory schema can be used to make up a DN.: {rdn}</td><td>App Owner Last Name: {metadata:AppOwnerLastName}</td></tr>\n<tr><td>SANs: {san The subject alternative name (SAN) is an extension to the X.509 specification that allows you to specify additional values when enrolling for a digital certificate. A variety of SAN formats are supported, with DNS name being the most common.}</td><td>App Owner Email Address: {metadata:AppOwnerEmailAddress}</td></tr>\n<tr><td>&nbsp;</td><td>Business Critical: {metadata:BusinessCritical}</td></tr>\n</table>\n\nPlease review this request and issue the certificate as appropriate by going here:\n\n{apprlink}\n\nThanks!\n\nYour Certificate Management Tool\n"

See Table 10: Substitutable Special Text for Pending Request Alerts in the Keyfactor Command Reference Guide for a complete list of available substitutable special text strings.

An integer indicating the certificate template for which the pending 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 pending certificate requests.

Use the GET /Templates method (see GET Templates) to retrieve a list of all the templates to determine the template ID.

An array containing the parameters configured for use by the event handler. The type of data will vary depending on the configured handler. Show event handler parameter details.

Value	Description
Id	An integer indicating the Keyfactor Command reference ID of the configured parameter A parameter or argument is a value that is passed into a function in an application..
Key	A string indicating the reference name of the configured parameter.
DefaultValue	A string indicating the value for the parameter. This value is related to the type of parameter (see ParameterType).
ParameterType	A string containing the parameter type. Supported types are: LogTarget This type is used for the event logging handler and is used to reference the fully qualified domain name of the target machine to which event should be logged. Script This type is used for the PowerShell handler and is used to reference the PowerShell script that should be run when the alert is triggered. It is referenced using the filename and optional relative path to the PowerShell script, located in the extensions directory on the Keyfactor Command server. Token This type is used for the PowerShell handler and is used to reference a substitutable special text value that should be passed to the PowerShell script. See Table 10: Substitutable Special Text for Pending Request Alerts in the Keyfactor Command Reference Guide for a complete list of available substitutable special text strings. Value This type is used for the PowerShell handler and is used to reference a static text string that should be passed to the PowerShell script.

For example, for a PowerShell handler:

"EventHandlerParameters": [
   {
      "Id": 28,
      "Key": "cn",
      "DefaultValue": "rcn",
      "ParameterType": "Token"
   },
   {
      "Id": 29,
      "Key": "AppOwnerFirstName",
      "DefaultValue": "metadata:AppOwnerFirstName",
      "ParameterType": "Token"
   },
   {
      "Id": 30,
      "Key": "Text",
      "DefaultValue": "Pending Alert: Enterprise Web Server",
      "ParameterType": "Value"
   },
   {
      "Id": 31,
      "Key": "ApprovalLink",
      "DefaultValue": "apprlink",
      "ParameterType": "Token"
   },
   {
      "Id": 32,
      "Key": "ScriptName",
      "DefaultValue": "MyScript.ps1",
      "ParameterType": "Script"
   }
]

A string indicating the subject for the email message that will be delivered when the alert is triggered.

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:

• {requester:mail}
  The certificate requester, based on a lookup in Active Directory of the email address associated with the requester on the certificate.

• Your custom email-based metadata field, which would be specified similarly to {metadata:AppOwnerEmailAddress}.

Show event handler details.

For more information about event handlers, see Using Event Handlers in the Keyfactor Command Reference Guide.