Defining reason codes for SSH approvals

When a workflow triggers an approval request, the approver receives a notification that includes the workflow’s associated reason code. The reason code provides instructions or information for the workflow approvers.

In the Workflow tree, you create the reason codes you want to associate with SSH, or Injection Command Approval Requests. For example, you may define a general reason code that indicates the cost associated with approving the key, or you may create separate reason codes with specific instructions for each type of workflow that requires approval.

IMPORTANT  You must have the View and Write permissions to the Workflow root.

Suppose you want to create reason codes for approving key provisioning or editing. Here are some sample reason codes you could create.

Remember, you create your own reason code numbers.

Reason Description

Approval for provisioning (Stage 10100)

A request to approve provisioning of an SSH key to a device has been made based on workflow "$CN[$SelfDN$]$". Approval is required for this process to proceed.

Approval for key edit (Stage 10200)

A request to edit an SSH key has been made based on workflow "$CN[$SelfDN$]$". Approval is required for this process to proceed.

Approval for key removal (Stage 10900)

A request to remove a key from a device has been made based on workflow "$CN[$SelfDN$]$". Approval is required for this process to proceed.

To learn about Workflow stages, see Workflow object settings.

To learn about working with macros, see Macro overview.

  1. From the Platform menu bar, click Policy Tree.
  2. Select the Root Workflow object.
  3. Click Create.

  4. Define the Reason Code settings.

    The following table describes the Reason Code settings.

    Field

    Description

    Create

    Creates a new Reason Code.

    Delete

    Deletes the currently selected Reason Code.

    Export

    Exports the Reason Codes to a CSV, tab-delimited, HTML, or XML file.

    Refresh

    Refreshes the contents of the current page.

    Code

    Number you associate with the current Reason Code.

    You select this number when you include a Reason Code in an approval workflow. For more information, see Approval Reason Code.

    Name

    Reason Code name

    Description

    Reason Code text that displays in the notification that is sent to the approver.

    Reason Codes provide customized explanations or instructions for approvers. You can provide standard information such as the cost associated with approving the certificate or you may provide specific instructions for the certificate approval.

    You can include Trust Protection Platform macro commands in the Reason Code description. The macro language allows administrators to call variable content for fields such as message body and workflow approver.

  5. Click Save/Add.

    The Reason Code now appears in the Reason Code list and can be selected when you create certificate approval workflows.