Skip to content

user

User commands.

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

Sub-commands

user whoami

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

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

Named Arguments

  • --viewer-paths: Include user's viewer_paths attribute. Default: False.

user register

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

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

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.

Named Arguments

  • --superuser: Give superuser privileges to the new user. Default: False.

user list

List all users.

fractal user list [-h]

user show

Show details of single user.

fractal user show [-h] user_id

Positional Arguments

  • user_id: ID of the user.

user edit

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

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

Positional Arguments

  • user_id: ID of the user.

Named Arguments

  • --new-email: New email address.

  • --new-password: New password.

  • --add-project-dir: New folder to add to user project_dirs.

  • --remove-project-dir: Folder to remove from user project_dirs.

  • --new-profile-id: New value of profile_id

  • --make-superuser: Give superuser privileges to user. Default: False.

  • --remove-superuser: Remove superuser privileges from user. Default: False.

  • --make-verified: Make user verified. Default: False.

  • --remove-verified: Make user unverified. Default: False.

user set-groups

Reset user-group membership for an existing user.

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

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.