group

UserGroup commands.

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

Sub-commands

group list

Get all groups.

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

Named Arguments

• --user-ids: Also return the user_ids lists together with the groups Default: False.

group get

Get single group.

fractal group get [-h] group_id

Positional Arguments

• group_id: ID of the group to get.

group new

Create new group.

fractal group new [-h] name

Positional Arguments

• name: Name of the new group.

group add-user

Add a single user to group.

fractal group add-user [-h] group_id user_id

Positional Arguments

• group_id: ID of the group to which to add the user.

• user_id: ID of the user to add.

group remove-user

Remove a single user from group.

fractal group remove-user [-h] group_id user_id

Positional Arguments

• group_id: ID of the group to which to remove the user.

• user_id: ID of the user to remove.