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

Change password at next sign-in: show, set or clear the mark of a user account.

Download as PDF

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

On this page

exp:userpasswordchangerequired

Change password at next sign-in: show, set or clear the mark of a user account.

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

./console exp:userpasswordchangerequired --help
./console exp:user-password-change-required --help
php bin/php/userpasswordchangerequired.php --help

Help text

Change password at next sign-in
Shows, sets or clears the mark that sends a user to the password change form after
their next sign-in, before any other page, until they set a new password (which clears
it). Guide: doc/eng-us/features/6.0/password-change-at-next-sign-in.md

./console exp:user-password-change-required status --login=editor1
./console exp:user-password-change-required set --login=editor1
./console exp:user-password-change-required clear --user-id=14
./console exp:user-password-change-required status --login=editor1 --json

In demo mode (EXP_DEMO_MODE=1) the mark of an administrator is kept but ignored.
Exit code: 0 done, 1 no such user, 2 usage error.

Options

OptionValueHelp
--loginrequiredThe login of the account
--user-idrequiredThe user (content object) id of the account
--jsonOne JSON object instead of the text

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: [ACTION].


Generated by ./console exp:help:examples from bin/php/userpasswordchangerequired.php, kernel/private/classes/commands/userpasswordchangerequired.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