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:expuserrequirepasswordchange

Require a new password at the account's next sign-in, or remove that mark with --clear, as the account's edit form does (a dry run unless --apply).

Download as PDF

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

On this page

exp:expuserrequirepasswordchange

Require a new password at the account's next sign-in, or remove that mark with --clear, as the account's edit form does (a dry run unless --apply).

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

./console exp:expuserrequirepasswordchange --help
./console exp:user:require-password-change --help
php bin/php/expuserrequirepasswordchange.php --help

Help text

Require a new password at the next sign-in
Marks the account, as "Change password at next sign-in" of its edit form does: after the next
sign-in the person must choose a new password before anything else. --clear removes the mark. The
audit records access.user.password.change_required.set or .clear. Without --apply nothing is
changed.

./console exp:user:require-password-change jane --apply
./console exp:user:require-password-change jane --clear --apply

Options

OptionValueHelp
--clearRemove the mark instead: no new password is required at the next sign-in
--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/expuserrequirepasswordchange.php, kernel/private/classes/commands/expuserrequirepasswordchange.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