burusftp user update
Modify an existing user in the database.
Synopsis
burusftp user update <username> [options]Options
Add public keys. Also sets key-auth to required when previously disabled.
2.15.0+ Enable or disable FTP access. default uses the server-wide setting.
PRO Enable or disable file system impersonation when a Windows account is set.
Enable, disable, or require public key authentication. Combine with --password-auth for two-factor authentication.
Lock the user (prevent login). Mutually exclusive with --unlock. Without a value, the user is locked indefinitely. With a value, the user is automatically unlocked after the specified date-time or interval.
- Date-time:
yyyy-MM-dd(e.g.2022-11-29) or"yyyy-MM-dd hh:mm:ss"(e.g."2022-11-29 15:30:45") - Interval: a number followed by a unit —
(m)inutes,(h)ours,(d)ays,(M)onths,(y)ears. Combinations are supported (e.g."3d 12h 45m").
Set a note about the user. Use --note "" to remove it.
Prompt for a new password. Also sets password-auth to required and password-auth-mode to local.
Set password. Also sets password-auth to required and password-auth-mode to local. Use --password "" to remove the password (same as --remove-pwd). Not recommended — use -p instead.
Enable, disable, or require password authentication. Combine with --key-auth for two-factor authentication.
PRO How the password is verified. local uses the built-in user database; windowsNetwork and windowsInteractive delegate to Windows authentication (--win-account must be set). Defaults to local when password is set, windowsNetwork when Windows account is set.
Remove public keys matching a SHA-256 base-64 fingerprint (or prefix), algorithm name (e.g. rsa), or * for all.
Remove the password. Also sets password-auth to disabled unless Windows authentication is active.
Remove the Windows account. Also sets password-auth to disabled if Windows authentication was in use.
Replace all existing public keys. Also sets key-auth to required when previously disabled.
Home directory for SSH terminal sessions. Defaults to the global sshShell.defaultHomeDirectory setting. Use "" to reset to the global default.
Only applies when the user connects via SSH in terminal shell mode.
Shell executable for SSH terminal sessions. Defaults to the global sshShell.defaultShellPath setting. Use "" to reset to the global default.
Only applies when the user connects via SSH in terminal shell mode.
Shell behavior. default uses the global sshShell setting. Only applies to SSH endpoints with Shell/SCP enabled.
Unlock the user and clear the failed login counter.
Allow or disallow access to the Web Administration tool.
PRO Windows account for authentication. Also sets password-auth-mode to windowsNetwork, password-auth to required, and impersonate to on.
Examples
# Change password
burusftp user update guybrush --password "kate"
# Replace existing public keys
burusftp user update guybrush --set-keys "C:\Users\guybrush\rsa.pub"
# Lock user indefinitely
burusftp user update guybrush --lock
# Lock user until a specific date
burusftp user update guybrush --lock "2022-01-31 08:30:00"
# Lock user for 7 days
burusftp user update guybrush --lock 7d
# Lock user for 3 days, 12 hours, and 45 minutes
burusftp user update guybrush --lock "3d 12h 45m"
# Unlock user
burusftp user update guybrush --unlockSee also
burusftp user add, burusftp user inspect, burusftp user delete