exp:expuserlist

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

Summary

List user accounts: filter by state (enabled, disabled, unactivated, pending, locked, never signed in, inactive ...), group and search, with paging

Usage

./console exp:expuserlist [options]
php bin/php/expuserlist.php [options]
./console exp:user:list [options]

Aliases

exp:user:list

Help

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

Usage: bin/php/expuserlist.php [OPTION]...
List user accounts
Lists the accounts with their id, login, e-mail address, last visit, state and main group, the
same list as Users > Hygiene in the administration. Filter by state, by group (its members at
any depth) and by a text in the login, name or e-mail address; page with --limit and --offset.
Changes nothing.

./console exp:user:list
./console exp:user:list --state=disabled --group=Editors
./console exp:user:list --state=inactive --days=365 --sort=last_visit
./console exp:user:list --search=example.com --limit=100 --offset=100 --format=json


Options:
  --state=VALUE   Only accounts in this state: all (default), enabled, disabled, unactivated, pending, locked, never, inactive, orphaned, duplicate_login or duplicate_email
  --group=VALUE   A user group by node id or name: list, export and bulk take only its members (below it, at any depth); create and import: the group of the new accounts (repeat for more, the first is the main group; default [UserSettings] DefaultUserPlacement)
  --search=VALUE  Only accounts whose login, name or e-mail address contains this text
  --days=VALUE    With --state=inactive: not signed in for this many days (default 180)
  --sort=VALUE    The order: name (default), login, email, last_visit, login_count or id
  --order=VALUE   asc (default) or desc
  --limit=VALUE   How many to list (default 25, at most 500); bulk: the most accounts one run may change (default 500, at most 5000)
  --offset=VALUE  Skip this many first (the next page: --offset=25)
  --format=VALUE  text (default) or json (the machine output exp-user/1)

Options

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

See also

Generated example: exp:expuserlist

Added to the reference for Exponential 6.0.15.