Skip to the content
Documentation

exp:expuserrequirepasswordchange

No ratings yet

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

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)

Usage

./console exp:expuserrequirepasswordchange [options]
php bin/php/expuserrequirepasswordchange.php [options]
./console exp:user:require-password-change [options]

Aliases

exp:user:require-password-change

Help

The output of ./console help exp:expuserrequirepasswordchange (the script run with --help), without the standard options:

Usage: bin/php/expuserrequirepasswordchange.php [OPTION]... [USER]
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:
  --clear         Remove the mark instead: no new password is required at the next sign-in
  --apply         Make the change; without it the command only lists what it would change (a dry run)
  --dry-run       The default, kept for scripts that pass it: list what would change, change nothing
  --as=VALUE      Act as this user (login, e-mail or id; default the user of [UserSettings] UserCreatorID); the audit records it as who did it
  --format=VALUE  text (default) or json (the machine output exp-user/1)

Options

Option Value Description
--clear - Remove the mark instead: no new password is required at the next sign-in
--apply - Make the change; without it the command only lists what it would change (a dry run)
--dry-run - The default, kept for scripts that pass it: list what would change, change nothing
--as required Act as this user (login, e-mail or id; default the user of [UserSettings] UserCreatorID); the audit records it as who did it
--format required text (default) or json (the machine output exp-user/1)

Arguments

[user]

Standard options

Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.

Source

bin/php/expuserrequirepasswordchange.php, kernel/private/classes/commands/expuserrequirepasswordchange.php

See also

Generated example: exp:expuserrequirepasswordchange

Added to the reference for Exponential 6.0.15.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.