fractal user¶

usage: fractal user [-h] {whoami,register,list,show,edit,set-groups} ...

User commands.

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

Valid sub-commands:
  {whoami,register,list,show,edit,set-groups}

usage: fractal user whoami [-h] [--viewer-paths]

Get info on current user (fails if user is not registered).

options:
  -h, --help      show this help message and exit
  --viewer-paths  Include user's `viewer_paths` attribute.

usage: fractal user register [-h] [--superuser]
                             new_email new_password new_project_dir

Register a new user with the Fractal server and edit their settings (note:
user creation and settings editing are two independent steps).

positional arguments:
  new_email        Email to be used as username.
  new_password     Password for the new user.
  new_project_dir  User-writeable base folder, used e.g. for default
                   `zarr_dir` paths.

options:
  -h, --help       show this help message and exit
  --superuser      Give superuser privileges to the new user.

usage: fractal user list [-h]

List all users.

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

usage: fractal user show [-h] user_id

Show details of single user.

positional arguments:
  user_id     ID of the user.

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

usage: fractal user edit [-h] [--new-email NEW_EMAIL]
                         [--new-password NEW_PASSWORD]
                         [--add-project-dir ADD_PROJECT_DIR]
                         [--remove-project-dir REMOVE_PROJECT_DIR]
                         [--new-profile-id NEW_PROFILE_ID]
                         [--make-superuser | --remove-superuser]
                         [--make-verified | --remove-verified]
                         user_id

Edit an existin user and/or their settings (note: user and settings editing
are two independent steps).

positional arguments:
  user_id               ID of the user.

options:
  -h, --help            show this help message and exit
  --new-email NEW_EMAIL
                        New email address.
  --new-password NEW_PASSWORD
                        New password.
  --add-project-dir ADD_PROJECT_DIR
                        New folder to add to user `project_dirs`.
  --remove-project-dir REMOVE_PROJECT_DIR
                        Folder to remove from user `project_dirs`.
  --new-profile-id NEW_PROFILE_ID
                        New value of `profile_id`
  --make-superuser      Give superuser privileges to user.
  --remove-superuser    Remove superuser privileges from user.
  --make-verified       Make user verified.
  --remove-verified     Make user unverified.

usage: fractal user set-groups [-h] user_id group_ids [group_ids ...]

Reset user-group membership for an existing user.

positional arguments:
  user_id     ID of the user.
  group_ids   List of the IDs of groups we want the user to be member.
              WARNING: this list replaces the current group memberships.

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