Skip to the content
Documentation

[UserAuditSettings]

No ratings yet

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

Summary

The group [UserAuditSettings] of settings/audit.ini.

File

settings/audit.ini; override it in settings/override/audit.ini.append.php, in a siteaccess or in an extension.

Settings

Setting Default Description
UserAudit enabled The user audit log (doc/eng-us/features/6.0/user-audit.md): one row per security event about a user account or a user group in the table expuser_audit, a copy of the access channel's records made by the sink useraudit ([AuditChannel_access] Sinks[]). Read on Users > User audit log (user/audit, policy user/audit), filtered and exported as CSV. enabled | disabled
Events[] access.user.*; access.role.assign; access.role.unassign; access.session.*; access.passkey.*; access.registration.*; access.permission.refused Which events: patterns as in [AuditEventSettings]; only records naming a user account (the account changed, signed in or refused, the user a role was assigned to) or a user group are kept. An event the audit does not record ([AuditEventSettings]) never reaches the table either.
RecordIP enabled The address of the request, as [AuditPrivacySettings] Field[actor.ip] leaves it (by default shortened to /24 or /48); disabled: never stored in the table. enabled | disabled
RetentionDays 730 Rows older than this are removed by the cronjob part useraudit (cronjobs/useraudit.php, in the infrequent group). 0 keeps them all.
MaxValueLength 2000 The longest before or after value stored, in bytes of JSON; a longer one is cut.

See also

Generated example: audit.ini [UserAuditSettings]

Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/audit.ini.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.