Skip to the content
Documentation

exp:userpasswordchangerequired

No ratings yet

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

Summary

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

Usage

./console exp:userpasswordchangerequired [options]
php bin/php/userpasswordchangerequired.php [options]
./console exp:user-password-change-required [options]

Aliases

exp:user-password-change-required

Help

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

Usage: bin/php/userpasswordchangerequired.php [OPTION]... [ACTION]
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:
  --login=VALUE    The login of the account
  --user-id=VALUE  The user (content object) id of the account
  --json           One JSON object instead of the text

Options

Option Value Description
--login required The login of the account
--user-id required The user (content object) id of the account
--json - One JSON object instead of the text

Arguments

[ACTION]

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/userpasswordchangerequired.php, kernel/private/classes/commands/userpasswordchangerequired.php

See also

Generated example: exp:userpasswordchangerequired

Added to the reference for Exponential 6.0.15.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.