diff --git a/src/caosdb/utils/caosdb_admin.py b/src/caosdb/utils/caosdb_admin.py index 4f32982275967f15e19a44953c551b9926cdb937..ff06624e3edc1379eff6dcbdfb4e8563433886d0 100755 --- a/src/caosdb/utils/caosdb_admin.py +++ b/src/caosdb/utils/caosdb_admin.py @@ -141,20 +141,20 @@ def do_set_user_password(args): def do_add_user_roles(args): - roles = admin._get_roles(user=args.user_name, realm=None) + roles = admin._get_roles(username=args.user_name, realm=None) for r in args.user_roles: roles.add(r) - admin._set_roles(user=args.user_name, roles=roles) + admin._set_roles(username=args.user_name, roles=roles) def do_remove_user_roles(args): - roles = admin._get_roles(user=args.user_name, realm=None) + roles = admin._get_roles(username=args.user_name, realm=None) for r in args.user_roles: if r in roles: roles.remove(r) - admin._set_roles(user=args.user_name, roles=roles) + admin._set_roles(username=args.user_name, roles=roles) def do_set_user_entity(args): @@ -178,7 +178,7 @@ def do_delete_user(args): def do_retrieve_user_roles(args): - print(admin._get_roles(user=args.user_name)) + print(admin._get_roles(username=args.user_name)) def do_retrieve_role_permissions(args): diff --git a/src/doc/administration.rst b/src/doc/administration.rst new file mode 100644 index 0000000000000000000000000000000000000000..91b85344a018618284349b4e8dd34fe6b365b94d --- /dev/null +++ b/src/doc/administration.rst @@ -0,0 +1,14 @@ +Administration +============== + +The Python script ``caosdb_admin.py`` should be used for administrative tasks. +Call ``python3 caosdb_admin.py --help`` to see how to use it. + +The most common task is to create a new user (in the CaosDB realm) and set a +password for the user (note that a user typically needs to be activated):: + + python3 caosdb_admin.py create_user anna + python3 caosdb_admin.py set_user_password anna + python3 caosdb_admin.py add_user_roles anna administration + python3 caosdb_admin.py activate_user anna + diff --git a/src/doc/index.rst b/src/doc/index.rst index e8cc93aa398de36c30833bc97ca79ce20564daa6..76a2f88f6d31dd9b5f17995b6d54ccc63eb33631 100644 --- a/src/doc/index.rst +++ b/src/doc/index.rst @@ -10,7 +10,8 @@ Welcome to PyCaosDB's documentation! Getting started <README_SETUP> tutorials/index Concepts <concepts> - Configuration <configuration> + Configuration <configuration> + Administration <administration> API documentation<_apidoc/modules> This is the documentation for the Python client library for CaosDB, ``PyCaosDB``.