fractal group¶

usage: fractal group [-h] {list,get,new,add-user,remove-user} ...

UserGroup commands.

options:
  -h, --help            show this help message and exit

Valid sub-commands:
  {list,get,new,add-user,remove-user}

usage: fractal group list [-h] [--user-ids]

Get all groups.

options:
  -h, --help  show this help message and exit
  --user-ids  Also return the `user_ids` lists together with the groups

usage: fractal group get [-h] group_id

Get single group.

positional arguments:
  group_id    ID of the group to get.

options:
  -h, --help  show this help message and exit

usage: fractal group new [-h] name

Create new group.

positional arguments:
  name        Name of the new group.

options:
  -h, --help  show this help message and exit

usage: fractal group add-user [-h] group_id user_id

Add a single user to group.

positional arguments:
  group_id    ID of the group to which to add the user.
  user_id     ID of the user to add.

options:
  -h, --help  show this help message and exit

usage: fractal group remove-user [-h] group_id user_id

Remove a single user from group.

positional arguments:
  group_id    ID of the group to which to remove the user.
  user_id     ID of the user to remove.

options:
  -h, --help  show this help message and exit