Skip to main content

SSH Username and Key

An SSH username/key account is a Linux username and an SSH private key.

note

Agent deployment doesn't use SSH accounts. You deploy an agent by running a command on the agent host, as Deploy an agent describes. Scans never use SSH accounts either.

Key Formats​

The form accepts a PEM-framed private key: the text must start with -----BEGIN and contain an -----END line. If it doesn't, the form shows SSH key must be in PEM or OpenSSH format. Three common formats meet this rule.

FormatFirst line
OpenSSH-----BEGIN OPENSSH PRIVATE KEY-----
Public-Key Cryptography Standards (PKCS) #1-----BEGIN RSA PRIVATE KEY-----
PKCS #8-----BEGIN PRIVATE KEY-----

Access Analyzer doesn't support passphrase-protected keys, and the form has no field for a passphrase. Create a key without a passphrase.

Create an SSH Username/Key Service Account​

  1. Go to Configuration > Service accounts.
  2. Click Add service account.
  3. In Name, enter a name, for example agent-deploy.
  4. In Service account type, select SSH username/key.
  5. In SSH username, enter the Linux username.
  6. In SSH key, paste the private key.
  7. Click Add account.

Add service account dialog with SSH username/key selected

Replace the Key​

  1. In the account's Actions menu, click Edit.
  2. In SSH key, paste the new private key.
  3. Click Save changes.

The SSH key field opens empty. To change other fields without replacing the key, leave it empty.

Fields​

FieldRequiredNotes
NameYesThe name shown in the list.
Service account typeYesSelect SSH username/key.
SSH usernameYesThe Linux username, for example deploy.
SSH keyYesThe private key, pasted in full including its -----BEGIN and -----END lines. The field is a multi-line text box.