grommunio-admin-user(1)

📦 version 1.18, in alpine 3.24

💖 NAME 💖

grommunio-admin user — User management. Bestie, this is the grommunio-admin-user(1) manual, and it's literally all about managing users. Periodt. ✨

🌸 SYNOPSIS 🌸

Copy these exactly, okay? No autocorrect, no vibes-based flag invention:

grommunio-admin user create [--no-defaults] [--no-maildir] [<FIELDS>]
USERNAME
grommunio-admin user delegate USERSPEC (clear | list)
grommunio-admin user delegate USERSPEC (add | remove) USERNAME ...
grommunio-admin user delete [-c] [-k] [-y] USERSPEC
grommunio-admin user devices USERSPEC (list | resync | remove | show)
[DEVICE ...]
grommunio-admin user devices USERSPEC wipe [--mode MODE] DEVICE
grommunio-admin user list [-f ATTRIBUTE=<value>] [-s FIELD] [USERSPEC]
grommunio-admin user login [--nopass] [--password PASSWORD] [--token]
USERNAME
grommunio-admin user modify [<FIELDS>] [--delete-chat-user] [--no-ldap]
[--remove-alias ALIAS] [--remove-altname ALTNAME] [--remove-property
PROPSPEC] [--remove-storeprop PROPSPEC] USERSPEC
grommunio-admin user query [-f ATTRIBUTE=<value>] [--format FORMAT]
[--separator SEPARATOR] [-s FIELD] [ATTRIBUTE ...]
grommunio-admin user sendas USERSPEC (clear | list)
grommunio-admin user sendas USERSPEC (add | remove) USERNAME ...
grommunio-admin user show [-f ATTRIBUTE=<value>] [-s FIELD] USERSPEC

✨ DESCRIPTION ✨

Subcommand for user management. That's it, that's the vibe: it's the user-management subcommand, and it's ready to slay your admin tasks. 🫶

🫶 COMMANDS 🫶

  • create — create a new user ✨
  • delegate — manage delegate permission
  • delete — delete user
  • devices — user mobile device management
  • list — list users. Deprecated. Use query instead.
  • login — test user login
  • modify — modify a user
  • query — query user attributes
  • sendas — manage send-as permission
  • show — show detailed information about a user
🚨 Deprecated alert: list is deprecated, bestie — use query instead. The old one is giving legacy energy.

💅 OPTIONS 💅

  • ATTRIBUTE — attributes to query. Available attributes are ID, aliases, changePassword, chat, chatAdmin, domainID, forward, homeserverID, lang, ldapID, maildir, pop3_imap, privArchive, privChat, privFiles, privVideo, privWeb, privDav, privEas, publicAddress, smtp, status and username. If no attributes are specified, ID, username and status are shown. 👑
  • DEVICE — limit command to given device ID(s)
  • USERNAME — E-Mail address of the user
  • USERSPEC — user name prefix or user ID
  • -c, --keep-chat — deactivate but do not permanently delete chat user
  • --delete-chat-user — permanently delete chat user
  • -f FIELD=<value>, --filter FIELD=<value> — filter expression in the form of ‘field=value’. Can be specified multiple times to refine filter
  • --format FORMAT — output format. Can be one of csv, json-flat, json-kv, json-object, json-structured and pretty. Default is pretty.
  • -k, --keep-files — do not delete user files from disk
  • --mode MODE — specify wipe status to set. Possible values are account and normal, or cancel to stop a pending wipe.
  • --no-defaults — do not apply configured default values
  • --no-ldap — detach user from LDAP object
  • --no-maildir — do not create a mailbox for that user
  • --nopass — skip password check
  • --password — user password. If omitted, password is retrieved from prompt.
  • --remove-alias ALIAS — remove ALIAS from user (can be given multiple times)
  • --remove-altname ALTNAME — remove ALTNAME from user (can be given multiple times)
  • --remove-property PROPSPEC — remove property from user (can be given multiple times)
  • --remove-storeprop PROPSPEC — remove property from user's store (can be given multiple times)
  • --separator SEPARATOR — string to use for column separation (csv and pretty only). Must have length 1 if format is csv. Default is "," for csv and " " for pretty.
  • -s FIELD, --sort FIELD — sort by field. Can be given multiple times
  • --token — generate access and CSRF token on successful login
  • -y, --yes — assume yes instead of prompting

🎀 FIELDS 🎀

  • --changePassword <bool> — whether the user can change the password
  • --chat <bool> — whether to create a chat user
  • --chatAdmin <bool> — whether the user has chat admin privileges
  • --homeserver ID — ID of the home server or 0 for local user
  • --lang LANG — user store language
  • --ldapID LDAPID — identifier of the LDAP object linked to the user
  • --pop3-imap <bool> — whether the user has the POP3/IMAP privilege
  • --privArchive <bool> — whether the user has the archiving privilege
  • --privChat <bool> — whether the user has the chat privilege
  • --privFiles <bool> — whether the user has the files privilege
  • --privVideo <bool> — whether the user has the video privilege
  • --privWeb <bool> — whether the user has the web privilege
  • --privDav <bool> — whether the user has the DAV privilege
  • --privEas <bool> — whether the user has the EAS privilege
  • --public-address <bool> — whether the user has the public address privilege
  • --smtp <bool> — whether the user has the SMTP privilege
  • --status STATUS — user address status. Either numeric value or one of normal, suspended, deleted or shared.
  • --alias ALIAS — add alias
  • --altname ALTNAME — add ALTNAME to user alternative login name list (can be given multiple times)
  • --property propspec=value — set property defined by propspec to value
  • --storeprop propspec=value — set store property defined by propspec to value
  • --username — rename user

🦋 SEE ALSO 🦋

Okay bestie, that's the whole page. Footer check: the line at the bottom is just grommunio-admin-user(1) — no source/version or date printed in this copy, so that's the cutest little mystery. 💅✨

📦 where this page comes from