SSH Keys

The 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. Keys component of the Keyfactor Web APIs includes methods necessary to allow a user with the SSH User Keyfactor Command role permission (see the SSH Permissions section of the Keyfactor Command Reference Guide) to generate an SSH key pairClosed In asymmetric cryptography, public keys are used together in a key pair with a private key. The private key is retained by the key's creator while the public key is widely distributed to any user or target needing to interact with the holder of the private key. for himself or herself, retrieve that key, update it, or delete it. Methods are also included to list and delete unmanaged keys—keys discovered on servers configured in inventory only mode.

Table 481: SSH Keys Endpoints

Endpoint

Method

Description

Link

/Unmanaged/{id}

DELETE

Delete a discovered unmanaged SSH key for the specified ID.

DELETE SSH Keys Unmanaged ID

/Unmanaged/{id}

GET

Retrieve details for a discovered unmanaged SSH key for the specified ID.

GET SSH Keys Unmanaged ID

/MyKey

GET

Retrieve details for a user's SSH key generated through Keyfactor Command.

GET SSH Keys My Key

/MyKey

POST

Generate a new SSH key pair for a user through Keyfactor Command.

POST SSH Keys My Key

/MyKey

PUT

Update an SSH key for a user through Keyfactor Command.

PUT SSH Keys My Key
Unmanaged DELETE Delete one or more discovered unmanaged SSH keys based on a selection query. DELETE SSH Keys Unmanaged
Unmanaged GET Retrieve details for one or more discovered unmanaged SSH keys based on a selection query. GET SSH Keys Unmanaged