GET SSH Keys Unmanaged ID

The GET /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/Unmanaged/{id} method is used to retrieve an unmanaged SSH key by ID. Keys discovered on SSH servers during inventory and discovery are considered unmanaged. This method returns HTTP 200 OK on a success with details for the requested SSH key.

Tip:  The following permissions (see Security Overview) are required to use this feature:

SSH: ServerAdmin OR
SSH: EnterpriseAdmin

SSH actions are affected by ownership on the server group with which the key is associated and limited for users with only the ServerAdmin role. For more information, see the SSH Permissions section in the Keyfactor Command Reference Guide.

Table 483: GET SSH Keys Unmanaged {id} Input Parameters

Name In Description
id Path Required. The Keyfactor Command reference ID for the unmanaged SSH key to be retrieved.

Use the GET /SSH/Keys/Unmanaged method (see GET SSH Keys Unmanaged) to retrieve a list of all the unmanaged keys to determine the unmanaged key's ID.

Table 484: GET SSH Keys Unmanaged {id} Response Data

Name Description
ID An integer indicating the Keyfactor Command reference ID for the SSH key.
Fingerprint

A string indicating the fingerprint of the public keyClosed 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.. Each SSH public key has a single cryptographic fingerprint that can be used to uniquely identify the key.
PublicKey A string indicating the public key of the 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..
KeyType

A string indicating the cryptographic algorithm used to generate the SSH key. Possible values are:

  • RSA

  • ECDSA

  • Ed25519
KeyLength An integer indicating the key lengthClosed The key size or key length is the number of bits in a key used by a cryptographic algorithm. for the SSH key. The key length supported depends on the key typeClosed The key type identifies the type of key to create when creating a symmetric or asymmetric key. It references the signing algorithm and often key size (e.g. AES-256, RSA-2048, Ed25519). selected. Keyfactor Command supports 256 bits for Ed25519 and ECDSA and 2048 or 4096 bits for RSA.
DiscoveredDate The date, in UTC, on which the SSH key was discovered.
Comments An array containing one or more strings with the user-defined descriptive comments, if any, on the key. Although entry of an email address in the comment field of an SSH key is traditional, this is not a required format. The comment may can contain any characters supported for string fields, including spaces and most punctuation marks. A key may appear with more than one comment if the originating authorized_keys file contained more than one comment.
LogonCount An integer indicating the number of Linux logons associated with the SSH key.