exp:expusergroups
User groups: list the group tree with its members, create, rename and move a group, remove an empty group to the trash (changes are a dry run unless --apply).
Script bin/php/expusergroups.php, code in kernel/private/classes/commands/expusergroups.php. Run it from the installation root, as the user the web server runs as:
./console exp:expusergroups --help
./console exp:user:groups --help
php bin/php/expusergroups.php --helpHelp text
User groups
list (the default) shows the user group tree below a group, or below the users root, with each
group's node id, its direct members and its subgroups. create makes a group (--name, below
--parent), rename gives it a new name (a new version, published with its workflows), move puts it
below another group, and delete moves an empty group to the trash: a group that still holds
accounts or groups is refused, because removing a group never removes accounts. Groups are named
by node id or name. Without --apply nothing is changed.
./console exp:user:groups
./console exp:user:groups list Editors
./console exp:user:groups create --name=Partners --parent=Members --apply
./console exp:user:groups rename Partners --name="Partner agencies" --apply
./console exp:user:groups move 245 --to=Editors --apply
./console exp:user:groups delete 245 --applyOptions
| Option | Value | Help |
|---|---|---|
--parent | required | groups create: the group the new group goes below (node id or name; default the users root, content.ini [NodeSettings] UserRootNode) |
--name | required | groups create and rename: the name of the group |
--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) |
--apply | Make the change; without it the command only lists what it would change (a dry run) | |
--dry-run | The default, kept for scripts that pass it: list what would change, change nothing | |
--as | required | Act as this user (login, e-mail or id; default the user of [UserSettings] UserCreatorID); the audit records it as who did it |
--format | required | text (default) or json (the machine output exp-user/1) |
Read from the option definitions in the code (startup(), getOptions(), options() or ezcConsoleOption). Every script also takes the standard options of the script framework (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).
Arguments: [action][group].
Related
Generated by ./console exp:help:examples from bin/php/expusergroups.php, kernel/private/classes/commands/expusergroups.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.