POST SSH/ConfirmSelfServiceKeyInstallation

Verifies that a user manually installed a private key.

Requirements

  • Permissions:  The caller must have Private Key Read permission.
  • Token scope:  SSH:Manage

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

KeysetId

The identifier of a set of public and private key pairs. Depending on your environment, the value may be expressed with or without curly braces {}. You can get the KeysetId, from POST SSH/KeyUsage or the SSH Keyset Inventory. For example:

Location of KeysetID in the UI

Returns

For valid requests, SSH/ConfirmSelfServiceKeyInstallation returns a HTTP 200 message and the following data in the message body:

Response description

Name

Description

Response SshWebResponse object with result of the operation. For more information, see SSH SshWebResponse object.

Example: Confirm SSH key installation

Request

POST https://tpp.venafi.example/vedsdk/ConfirmSelfServiceKeyInstallation
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "KeysetId":"3E29BB6763233D6AC60E82F22EC5E069D7DF94FE"
}

Response

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