describe-ssh-public-key¶

Description¶

Describe an SSH public key for an actor.

Synopsis¶

  describe-ssh-public-key
--crn-or-fingerprint <value>
[--actor-crn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--crn-or-fingerprint (string)

The SSH public key CRN or its SHA256 fingerprint.

--actor-crn (string)

The CRN of the user or machine user that the SSH public key belongs to. If it is not included, it defaults to the actor making the request.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

sshPublicKey -> (object)

Information about an SSH public key.

crn -> (string)

The SSH public key CRN.

publicKeyFingerprint -> (string)

The SSH public key SHA256 fingerprint. This is identical to the SHA256 produced by running the following command on a public key named ‘key.pub’; ssh-keygen -l -E SHA256 -f /home/user/.ssh/key.pub. Note that ssh-keygen removes any padding bytes from the BASE64 fingerprint encoding (the ‘=’ characters at the end of the fingerprint) which is also true for this fingerprint.

description -> (string)

An optional description for the public key.

publicKey -> (string)

The SSH public key string. Only populated for DescribeSshPublicKeyResponses. This is the same string that was used when the key was added.

Form Factors¶

public