Fractal Server User¶

The sub-command for the qcfractal-server CLI which manages user permissions and passwords.

Command Invocation¶

qcfractal-server user [<options>]

--base-folder [<folder>]: The QCFractal base directory to attach to. Default: ~/.qca/qcfractal.

The qcfractal-server user CLI allows for manipulation of users through four subcommands:

qcfractal-server user add [<options>] <username>

This command adds a new user, setting the user’s password and permissions. The user must not already exist.

<username>: The username to add.
--password [<password>]: The password for the user. If this option is not provided, a password will be generated and printed.
--permissions [<permissions>]: Permissions for the user. Allowed values: read, write, queue, compute, admin. Multiple values are allowed. At least one value must be specified.

qcfractal-server user show <username>

This command prints the permissions for a given user.

qcfractal-server user modify [<options>] <username>

This command modifys a user’s permissions or password.

<username>: The username to modfiy.
--password [<password>]: Change the user’s password to a given string. This options excludes --reset-password.
--reset-password: Change the user’s password to an auto-generated value. The new password will be printed. This option excludes --password.
--permissions [<permissions>]: Change the user’s permissions to the given set. Allowed values: read, write, queue, compute, admin. Multiple values are allowed. See User Permissions for more information.

qcfractal-server user remove <username>

This command removes a user.

Five permission types are available:

read allows read access to existing records.
write allows write access to existing records and the ability to add new records.
compute allows enqueuing new Tasks.
queue allows for consumption of compute Tasks. This permission is intended for use by a Manager.
admin allows all permissions.