GET SSH Keys My Key
The GET /SSH
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/MyKey method is used to retrieve the current user's SSH key generated in Keyfactor Command (see POST SSH Keys My Key). This method returns HTTP 200 OK on a success with the key's details.
Table 487: GET SSH Keys My Key Input Parameters
| Name | In | Description |
|---|---|---|
| includePrivateKey | Query | A Boolean that sets whether to include the private key Private keys are used in cryptography (symmetric and asymmetric) to encrypt or sign content. In asymmetric cryptography, they are used together in a key pair with a public key. The private or secret key is retained by the key's creator, making it highly secure. of the SSH key pair 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. in the response (true) or not (false). If set to true, the x-keyfactor-key-passphrase header must be supplied. The default is false. |
| x-keyfactor-key-passphrase | Header | Required*. A string that sets a password used to secure the private key of the SSH key pair for download. This field is required if IncludePrivateKey is set to true. Tip: This password does not need to match the password entered to secure the private key when the SSH key pair was initially generated. The private key is encrypted at download time and a different password may be used for each download. |
Table 488: GET SSH Keys My Key Response Data
| Name | Description |
|---|---|
| ID | The Keyfactor Command reference ID for the user's SSH key pair. |
| Fingerprint |
A string indicating the fingerprint of the public key |
| PublicKey | A string indicating the public key of the key pair. |
| PrivateKey | A string indicating the private key of the key pair. |
| KeyType |
A string indicating the cryptographic algorithm used to generate the SSH key pair. Possible values are:
|
| KeyLength | An integer indicating the key length 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 type 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. |
| CreationDate | The date, in UTC, on which the SSH key pair was created. |
| StaleDate |
The date, in UTC, on which the SSH key pair will be considered to have reached the end of its lifetime. By default, the lifetime of an SSH key pair is 365 days. The SSH lifetime is defined by the Key Lifetime (days) application setting. See in the Keyfactor Command Reference Guide for more information. |
| A string containing the email address of the user who requested the key. This email address is used to alert the user when the key pair is approaching the end of its lifetime. | |
| 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. Keys created through the Keyfactor Command My SSH Key portal or with the POST /SSH/Keys/MyKey method will contain only one string in the array. |
| LogonCount | An integer indicating the number of Linux logons associated with the SSH key pair. |
) at the top of the Keyfactor Command Management Portal page next to the Log Out button.
