Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

exp:expuserunlock

Unlock an account locked after too many wrong passwords: its failed sign-ins back to 0, as Users > Hygiene does (a dry run unless --apply).

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/commands/expuserunlock.md

On this page

exp:expuserunlock

Unlock an account locked after too many wrong passwords: its failed sign-ins back to 0, as Users > Hygiene does (a dry run unless --apply).

Script bin/php/expuserunlock.php, code in kernel/private/classes/commands/expuserunlock.php. Run it from the installation root, as the user the web server runs as:

./console exp:expuserunlock --help
./console exp:user:unlock --help
php bin/php/expuserunlock.php --help

Help text

Unlock an account
An account is locked after more wrong passwords than [UserSettings] MaxNumberOfFailedLogin. This
sets its failed sign-ins back to 0, as Users > Hygiene does, so the person can sign in again;
the password stays. The audit records access.user.unlock. Without --apply nothing is changed.

./console exp:user:unlock jane
./console exp:user:unlock jane --apply

Options

OptionValueHelp
--applyMake the change; without it the command only lists what it would change (a dry run)
--dry-runThe default, kept for scripts that pass it: list what would change, change nothing
--asrequiredAct as this user (login, e-mail or id; default the user of [UserSettings] UserCreatorID); the audit records it as who did it
--formatrequiredtext (default) or json (the machine output exp-user/1)

Read from the option definitions in the code (startup(), getOptions(), options() or ezcConsoleOption). Every script also takes the standard options of the script framework (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).

Arguments: [user].


Generated by ./console exp:help:examples from bin/php/expuserunlock.php, kernel/private/classes/commands/expuserunlock.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x