Skip to main content
Version: current

ssh-keys


user/ssh-keys​

Type: Directory

Public SSH keys assigned to users; the keys authenticate those users' incoming SSH logins. When a user has at least one key assigned, the SSH server refuses password authentication for that user and offers only public-key authentication. See User for the full guide.

ArgumentTypeDescription
userenumSystem user the key is assigned to.
infostringFree-text label for the key. When adding a key with key, a trailing comment in the pasted OpenSSH key string becomes the key's info and overrides this parameter.
keystringPublic key string, set only when adding a new key. Only the OpenSSH single-line format is accepted; PEM blocks are rejected.
Read-only ArgumentTypeDescription
key-typeenum (rsa | ed25519 | ed25519-sk)Type of the key: rsa, ed25519 or ed25519-sk.
bitsnumKey length in bits.
fingerprintstringSHA256 fingerprint of the key in base64 (for example SHA256:...).