Retrieve private SSH key account

This method allows users to retrieve a private SSH key file to their local computer. It enables users to specify a reason and Ticket ID. The private SSH key file is from an existing account that is identified by its Account ID.

To get a password value, see the Get password value REST API.

URL

Make sure there are no spaces in the URL.

The following characters are not supported in URL values: + & %
If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/

https://<IIS_Server_Ip>/PasswordVault/API/Accounts/{accountId}/Secret/Retrieve/

Resource information

HTTP method	Content type
POST	application/json

Header parameter

Parameter	Description
Authorization	The token that identifies the session, encoded in BASE 64. See Authentication. Type: String Mandatory: Yes Default value: None

Body parameters

{

reason:"<Reason>",

TicketingSystemName: "<Ticketing system>",

TicketId: "<Ticketid>",

Version: <version number>,

ActionType: "<action type - download>

isUse: <true\false>,

Machine: "<my remote machine address>"

}

Parameter	Description
Reason	The reason for retrieving the private SSH key. Type: string Mandatory: no Default value: none
TicketId	The ticket ID defined in the ticketing system. Type: string Mandatory: no Default value: none
TicketingSystem	The name of the ticketing system. Type: string Mandatory: no Default value:none
IsUse	Internal parameter (for use of PSMP only) Type: bool Mandatory: no Default value: false
ActionType	The action this SSH key is used for (retrieve). Type: string Mandatory: no Default value: no
Machine	The address of the remote machine that the user wants to connect to using the SSH key. Type: string Mandatory: no Default value: none
Version	The version number of the required SSH key. Must be a positive number. If the value is left empty or the value passed does not exist, then the current SSH key version is returned. Type: int Mandatory: no Default value: none

Result

Parameter	Description
keyfilename.pem	Downloaded file that contains the private SSH key secret. Type: pem file Value: the private SSH key secret

Parameter

Description

keyfilename.pem

Downloaded file that contains the private SSH key secret.

Type: pem file

Value: the private SSH key secret

Return codes

For a complete list of return codes, see Return Codes.