POST SSH/ApproveKeyOperation

Approves any key operation that has a Pending Approval status in a workflow. For example, this method can approve the addition, removal, or editing of a specified key. If no operation is pending current user approval for the key, the method does nothing.

If you decide to reject a key operation, call POST SSH/RejectKeyOperation.

NOTE   To set up workflows and reason codes for keys, use the UI. For more information, see Implementing SSH workflow management.

Requirements

  • Token scope:  SSH:Approve

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

Input parameters

Name

Description
KeyId

An identifier of a public or private key that requires workflow approval.

You can use POST SSH/KeysetDetails to select keysets that contain keys that have a pending approval ProcessStatus of 11. Then, iterate through them to find the appropriate KeyID that has a ProcessStatus of 7 (PendingMyApproval). For more information, see SSH Process status result codes.
Comment The reason why the operation was approved.

Returns

Response description

Name

Description

Response

The SshWebResponse object with result of the operation. For more information, see SSH SshWebResponse object. For error information, see SSH web error codes.

Example: Approve a key operation

Request

POST https://tpp.venafi.example/vedsdk/SSH/ApproveKeyOperation
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "KeyId":"22",
   "Comment":"Approve key deletion"
}

Response

HTTP/1.1 200 OK
{
   "Success":true
}