Options
These options can be set when creating or updating an SSH key verification session.
external_id
Section titled “external_id”Optional identifier for linking the SSHVerify session to an entity in your own system, such as a user ID, invite ID, or device ID.
expired_at
Section titled “expired_at”Absolute date and time when the session expires. New connections are rejected after this time. Do not use expired_at
and timeout together.
timeout
Section titled “timeout”Relative expiration duration for the session. Use this when you want the session to expire a fixed amount of time after
creation. Do not use timeout and expired_at together.
Public keys to verify. Each key can include:
| Field | Description |
|---|---|
public_key | Required public key in OpenSSH or PEM format. |
name | Optional display name. |
external_id | Optional identifier for linking the key to your own system. |
match_all_keys
Section titled “match_all_keys”Require all configured keys to be verified. When disabled, one matching key can verify the session.
max_attempts
Section titled “max_attempts”Maximum number of connection attempts before the session fails. The default is 1, and the value must be at least 1.
multi_key
Section titled “multi_key”Check multiple keys offered by the same SSH connection. When disabled, verification stops after the first matching key.
multi_connection
Section titled “multi_connection”Keep accepting later SSH connections for the same session. Multi-connection sessions are not completed automatically after a successful verification; complete them manually from the app or with the API.
must_confirm
Section titled “must_confirm”Require the user to confirm verification in their SSH client by pressing y.
ssh_banner
Section titled “ssh_banner”Optional SSH banner shown before authentication.
ssh_message
Section titled “ssh_message”Optional message shown after the user connects.