Options
When creating an SSH Key Verification Session, multiple options are available.
external_id
Section titled “external_id”The external id is an optional identifier can that be provided for the session, which can be used to link the session to an entity in another system.
expired_at
Section titled “expired_at”This option indicates when the session should be marked as expired. No new connections will be accepted after this date.
All the Public Keys that should be verified.
match_all_keys
Section titled “match_all_keys”This option indicates whether all provided keys should be matched during verification. If set to true, the user must
have access to all specified keys for the verification to be successful.
max_attempts
Section titled “max_attempts”This option specifies the maximum number of connection attempts allowed for the session. Once this limit is reached,
the session will be marked as failed. When not specified or set to 0, there is no limit on the number of attempts.
multi_key
Section titled “multi_key”This option indicates that multiple keys should be collected within the same connection when a user connects to the
session. When this option is not set to true, only the first key of the user will be collected.
multi_connection
Section titled “multi_connection”This option indicates that the session will not be marked as completed after the first connection, but that keys of later connections are also collected. This will prevent the session from being marked as completed, since it will keep collecting keys of new connections.