Skip to the content
Documentation

exp:expuserunlock

No ratings yet

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

Summary

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)

Usage

./console exp:expuserunlock [options]
php bin/php/expuserunlock.php [options]
./console exp:user:unlock [options]

Aliases

exp:user:unlock

Help

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

Usage: bin/php/expuserunlock.php [OPTION]... [USER]
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:
  --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
--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/expuserunlock.php, kernel/private/classes/commands/expuserunlock.php

See also

Generated example: exp:expuserunlock

Added to the reference for Exponential 6.0.15.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.