Options
These options can be set when creating or updating an SSH key collection 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 support ticket 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.
multi_key
Section titled “multi_key”Collect multiple keys from the same SSH connection. When disabled, SSHVerify stores only the first key offered by the client.
multi_connection
Section titled “multi_connection”Keep accepting later SSH connections for the same session. Multi-connection sessions are not completed automatically; complete them manually from the app or with the API.
must_confirm
Section titled “must_confirm”Require the user to confirm collection 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.
SFTP options
Section titled “SFTP options”The web app also exposes SFTP collection options:
| Option | Description |
|---|---|
sftp_enabled | Allow users to submit keys through the SFTP subsystem. |
sftp_list_keys | Allow users to list collected keys over SFTP when SFTP is enabled. |
These options are currently part of the app and GraphQL workflow. They are not exposed in the REST session schema.