Bulk create users
A Jahia community module that provides a UI and GraphQL API to bulk-create users from a CSV file, with optional group assignment.
Features
- Bulk user creation from a CSV file via a React admin UI
- Column selection: choose which optional properties to import per run
- Group assignment using
[group1],[group2]bracket notation - Skips existing users (increments skipped count) instead of failing
- Detailed import result: created, skipped, error counts and per-row error messages
- Max upload size enforced from Jahia's own
SettingsBeanconfiguration - GraphQL mutation API (
bulkCreateUsersImport) for programmatic imports - Site-scoped or global user creation
Captures d'écran
Comment installer
Requirements
- Jahia
8.2.1.0or later - Module dependencies:
default,graphql-dxm-provider
Installation
Deploy the module on your Jahia environment. The Bulk Create Users option becomes available under Administration → [site] → Settings → Bulk Create Users.
FAQ
CSV Format
Required columns
| Column | Description |
|---|---|
j:nodename |
Username (must be unique) |
j:password |
Initial password |
j:firstName |
First name |
j:lastName |
Last name |
Optional columns
| Column | Description |
|---|---|
j:email |
Email address |
groups |
Bracket-separated group names: [group1],[group2] |
Any j:* property |
Any other user property supported by Jahia |
The UI displays all optional columns detected in the CSV header and lets you toggle each one before importing. Unselected columns are ignored by the backend.
Delimiter
The default delimiter is ,. Any single character is accepted (e.g. ;, |). Set it in the UI before uploading.
Example
j:nodename,j:password,j:firstName,j:lastName,j:email,groups alice,Secret1234!,Alice,Smith,alice@example.com,[editors],[privileged] bob,Secret1234!,Bob,Jones,bob@example.com,[editors]
GraphQL API
Query
query {
bulkCreateUsersMaxUploadSize # returns the configured max size in bytes
}
Mutation
mutation {
bulkCreateUsersImport(
csvContent: "...",
separator: ",",
siteKey: "mySite", # omit for global users
selectedColumns: ["j:firstName", "j:lastName", "j:email", "groups"]
) {
success
createdCount
skippedCount
errorCount
errors
}
}
Both operations require the adminUsers permission.
MIT License
Copyright (c) 2022 - 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.