Skip to the content
Documentation

exp:expuseraudit

No ratings yet

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

Summary

The user audit log of an account (Users > Audit): what happened to it and what it did, newest first, filtered by event, result and days

Usage

./console exp:expuseraudit [options]
php bin/php/expuseraudit.php [options]
./console exp:user:audit [options]

Aliases

exp:user:audit

Help

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

Usage: bin/php/expuseraudit.php [OPTION]... [USER]
The user audit log of an account
Lists the rows of the user audit log (Users > Audit, the table expuser_audit) about the account or
by it, newest first: time, event, result, who acted, about whom, and the siteaccess. Filter by an
event name or prefix, a result and a range of days. The values before and after are in the JSON
output; passwords and secrets are never in the log. Changes nothing.

./console exp:user:audit jane
./console exp:user:audit jane --event=access.user.password --from=2026-10-01
./console exp:user:audit jane --result=refused --limit=100 --format=json


Options:
  --event=VALUE   Only events with this name or a name below it (access.user.password)
  --result=VALUE  Only events with this result: success, refused or failed
  --from=VALUE    Only events on or after this day (YYYY-MM-DD)
  --to=VALUE      groups move: the group to move it below (node id or name); audit: only events on or before this day (YYYY-MM-DD)
  --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

Option Value Description
--event required Only events with this name or a name below it (access.user.password)
--result required Only events with this result: success, refused or failed
--from required Only events on or after this day (YYYY-MM-DD)
--to required groups move: the group to move it below (node id or name); audit: only events on or before this day (YYYY-MM-DD)
--limit required How many to list (default 25, at most 500); bulk: the most accounts one run may change (default 500, at most 5000)
--offset required Skip this many first (the next page: --offset=25)
--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/expuseraudit.php, kernel/private/classes/commands/expuseraudit.php

See also

Generated example: exp:expuseraudit

Added to the reference for Exponential 6.0.15.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.