GET Alerts Key Rotation

The GET /Alerts/KeyRotation method is used to retrieve details of all SSHClosed The SSH (secure shell) protocol provides for secure connections between computers. It provides several options for authentication, including public key, and protects the communications with strong encryption. key rotation alerts configured in Keyfactor Command. Results can be limited to selected alerts using filtering, and URL parameters can be used to specify paging and sorting. This method returns HTTP 200 OK on a success with details about the specified SSH key rotation alerts.

Tip:  The following permissions (see Security Overview) are required to use this feature:

WorkflowManagement: Read

Table 152: GET Alerts Key Rotation Input Parameters

Name In Description
queryString Query

A string containing a query to limit the results (e.g. field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to the Keyfactor Command Reference Guide: Certificate Search Page. The query fields supported for this endpoint are:

  • Days
  • DisplayName
  • Message
  • RegisteredEventHandlerId
  • ScheduledTaskId
  • Subject
  • UseHandler
pageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
returnLimit Query An integer that specifies how many results to return per page. The default is 50.
sortField Query A string containing the property by which the results should be sorted. Fields available for sorting through the API for the most part match those that appear as sortable columns in the Keyfactor Command Management Portal. The default sort field is DisplayName.
sortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.

Table 153: GET Alerts Key Rotation Response Data

Name Description
Id An integer indicating the Keyfactor Command reference ID of the SSH key rotation alert.
DisplayName A string indicating the display name for the SSH key rotation alert. This name appears in the SSH key rotation alerts grid in the Management Portal.
Subject

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

Tip:  Substitutable special text may be used in the subject line. Substitutable special text uses a variable in the alert definition that is replaced by data from the key record at processing time. For example, you can enter {comment} in the alert definition and each alert generated at processing time will contain the specific key comment of the given SSH key instead of the variable {comment}.
Message

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\nYou requested an SSH key pair almost a year ago with the following information:\n\n<table>\n<tr><th>Field</th><th>Value</th></tr>\n<tr><td>Username</td><td>{username}</td></tr>\n<tr><td>Fingerprint</td><td>{fingerprint}</td></tr>\n<tr><td>Comment</td><td>{comment}</td></tr>\n<tr><td>Key Length</td><td>{keylength}</td></tr>\n<tr><td>Key Type</td><td>{keytype}</td></tr>\n<tr><td>Number of Server Logons for Key</td><td>{serverlogons}</td></tr>\n</table>\n\nCorporate policy requires key rotation every year. Please visit the <a href=\"https://[your_server_name]/KeyfactorPortal/SshMyKey\">My SSH Key Portal</a> for user keys or the <a href=\"https://[your_server_name]/KeyfactorPortal/SshServiceAccountKeys\">Service Account Key Portal</a> for service account keys and request a new key pair.\n\nThanks!"

See Table 13: Substitutable Special Text for Key Rotation Alerts in the Keyfactor Command Reference Guide for a complete list of available substitutable special text strings.
RotationWarningDays An integer indicating the number of days prior to the end of an SSH key's lifetime the alert should be triggered.
RegisteredEventHandler An object containing the event handler configuration for the alert, if applicable. ClosedShow event handler details.

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

An array containing the parameters configured for use by the event handler. The type of data will vary depending on the configured handler. ClosedShow event handler parameter details.
Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.