restauth-user man page

restauth-user — manage users in RestAuth

Synopsis

restauth-user.py [-h] command [option] ... [args] ...

Description

restauth-user.py manages users in RestAuth. Users are clients that want to authenticate with services that use RestAuth.

Note that restauth-user.py does not enforce restrictions on usernames as rigorously as the when handling users through the standard interface. Instead, only characters explicitly forbidden by the protocol specification are blocked. This way it is easy to handle users (about to be) imported from other systems.

Usage

Use one of the commands (either set-password, verify, list, add, rm or view) to perform the respective operation. Each command usually requires more arguments to it, see the respective section for arguments (and possible options) for each command.

Use "restauth-user.py --help" to get an authoritative list of available commands. If you want help on a specific command, use "restauth-user.py command --help" or see the Available Commands section below.

Examples

restauth-user.py add exampleuser

Add a user called exampleuser. Since neither --password nor --gen-password was specified, restauth-user.py will prompt for a password.

restauth-user.py add --gen-password exampleuser

Add a user called exampleuser, automatically generate a password and print it to stdout.

restauth-user.py view exampleuser

View all details of exampleuser.

restauth-user.py list

List all users known to RestAuth.

restauth-user.py verify --password=foobar exampleuser

Verify that exampleuser has the password foobar. restauth-user.py will exit with status code 0 if the password matches and 1 if not.

restauth-user.py set-password --gen-password exampleuser

Generate a new password for exampleuser.

restauth-user.py rm exampleuser

Remove exampleuser from RestAuth.

Available Commands

The following subsections never document the '-h' parameter for clarity.

add [-h] [--password PWD | --gen-password] user

Add a new user.

--password PWD

The password to use.

--gen-password
Generate a password and print it to stdout.
USER
The name of the user.

ls [-h]

List all users.

rename [-h] user NAME

Rename a user.

USER

The name of the user.

NAME
The new name for the user.

rm [-h] user

Remove a user.

USER
The name of the user.

set-password [-h] [--password PWD | --gen-password] user

Set the password of a user.

--password PWD

The password to use.

--gen-password
Generate a password and print it to stdout.
USER
The name of the user.

verify [-h] [--password PWD | --gen-password] user

Verify the password of a user.

--password PWD

The password to use.

--gen-password
Generate a password and print it to stdout.
USER
The name of the user.

view [-h] [--service SERVICE] user

View details of a user.

--service SERVICE

View information as SERVICE would see it.

USER
The name of the user.

Influential Environment Variables

DJANGO_SETTINGS_MODULE
The path to the Django settings module. If not set, RestAuth.settings is used, which should be fine in most cases. For more information, please read the Django documentation.
PYTHONPATH
A semi-colon (';') seperated list of additional directories to search for python modules. The RestAuth installation must be in the module search path for any commands to work. For more information, please read the official python documentation.

See Also

restauth-service(1), restauth-group(1), restauth-import(1)

Author

Mathias Ertl

Referenced By

restauth-group(1), restauth-import(1), restauth-manage(1), restauth-service(1).

February 05, 2016 0.6.3 RestAuth