Options

When creating an SSH Key Collection Session, multiple options are available.

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

This option indicates when the session should be marked as expired. No new connections will be accepted after this date.

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

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.