Report users and groups icon
Module Id
report-users-and-groups
Group Id
org.jahia.community
Updated
Requires Jahia
8.2.1.0
Author
Florent BOURASSE
Category
Tools and Utilities
Status
COMMUNITY info

Report users and groups group_work

audit user export

This feature is now included in the community module Content Reports 2026.

Dependencies & Dependants

Dependants
  • NONE

Changelog 2.0.1

Highlights

  • Hardened CSV export with millisecond-precision filenames and Sonar issue cleanup.
  • Comprehensive WCAG 2.1 AA accessibility remediation across the admin UI.
  • Security posture improvements: Dependabot config, CVE upgrades, and revised security policy.
  • Documentation modernized for the v2 module (admin UI, folder picker, GraphQL API, CSV format).

Features

  • 55385c0 Update README for v2: admin UI, folder picker, GraphQL API, CSV format.
  • 406bf38 Add CLAUDE.md with module architecture and context.
  • 4387ba5 Rename CLAUDE.md to AGENTS.md and add CLAUDE.md reference.

Fixes

Accessibility (WCAG 2.1 AA)

  • 9b9f406 Resolve WCAG 2.1 AA accessibility issues in admin UI.
  • 2577c0b WCAG 2.1 AA accessibility issues (CRITICAL-01..03, MAJOR-01..06, MINOR-03..10).
  • 9590513 SC 2.5.8 touch target size for property checkboxes.
  • 22a941a Add appearance:auto to checkboxes for cross-browser width/height.

Security / Dependencies

  • 6511865 CVE fix: upgrade systeminformation from 5.31.5 to 5.31.6 via resolution.
  • f84bccc Dependabot alerts: upgrade @babel/plugin-transform-modules-systemjsfast-uriaxiosip-address.
  • 7db2aa6 Add .github/dependabot.yml.
  • 92e0211 Revise security policy and reporting instructions.

CSV export

  • e55ef43 Bump CSV filename precision to milliseconds (yyyyMMdd-HHmmss-SSS) to support back-to-back report generation without filename collisions. Cypress regexes (02-reportUsersAndGroups-API.cy.ts07-reportUsersAndGroupsUI-GenerationDeletion.cy.ts) updated to match.

Tooling / Tests

  • b459d70 Update Cypress test selector and switch yarn to node-modules linker.

Refactoring

  • 7493982 Harden CSV export and fix Sonar issues in ReportUsersAndGroupsCommand and ReportUsersAndGroupsQueryExtension.

Full Changelog2_0_0...2_0_1

FAQ

Administration UI

Navigate to Administration → Server → Users and Roles → Report Users & Groups.

Field Description
JCR root path JCR path where report files are stored. Use the Browse… button to navigate the repository tree. Default: /sites/systemsite/files
User properties to export Checkbox list of all jnt:user properties. Select the ones to include as extra columns. j:firstName and j:lastName are pre-selected.

Click Generate report (or press Ctrl+Enter) to start generation. The page polls every 2 seconds while the report is being generated and shows the result in the Generated reports table once complete.

Each report row provides:

  • The creation date and time
  • A direct download link (report-users-and-groups-YYYYMMDD-HHmm.csv)
  • Delete button to remove the file from the JCR

Karaf shell command

report-users-and-groups:execute [options] [userPropertiesToExport]...

Options:

Name Alias Default Description
-p --csvRootPath /sites/systemsite/files JCR root path where the CSV file is stored

Arguments:

Name Description
userPropertiesToExport Space-separated list of jnt:user property names to include as columns

Example:

report-users-and-groups:execute -p /sites/digitall/files j:firstName j:lastName j:email

Background job

The job Maintenance.ReportUsersAndGroupsJob runs automatically every day at 01:30 AM by default.

Configure it via Jahia system properties (e.g. in jahia.properties or environment variables):

Property Default Description
jahia.reportsusersandgroups.job.csvRootPath /sites/systemsite/files JCR root path where the CSV file is stored
jahia.reportsusersandgroups.job.userPropertiesToExport j:firstName,j:lastName Comma-separated list of jnt:user property names to export
jahia.reportsusersandgroups.job.cronExpression 0 30 1 * * ? Quartz cron expression

CSV format

The generated file is named report-users-and-groups-YYYYMMDD-HHmm.csv and stored under:

<csvRootPath>/report-users-and-groups/<yyyy>/<MM>/<dd>/<HH>/<mm>/<ss>/

Columns:

Column Description
site Site name (global for /users, site name for /sites/<name>/users)
user name The JCR node name of the user
(selected properties) One column per selected jnt:user property (e.g. j:firstNamej:email)
groups Comma-separated list of group memberships (system groups excluded)

How To Install

Requirements

  • Jahia 8.2.1.0 or later
  • Modules: defaultgraphql-dxm-providerserverSettings

Installation

  • In Jahia, go to "Administration --> Server settings --> System components --> Modules"
  • Upload the JAR report-users-and-groups-X.X.X.jar
  • Check that the module is started

Images

License

MIT License

Copyright (c) 2023 - present Jahia

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.