Skip to content

Commit 91dd46a

Browse files
committed
added docs for piccolo user change_permissions
1 parent 0af412c commit 91dd46a

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/src/piccolo/authentication/baseuser.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,25 @@ Change a user's password.
4141
4242
piccolo user change_password
4343
44+
user change_permissions
45+
~~~~~~~~~~~~~~~~~~~~~~~
46+
47+
Change a user's permissions. The options are ``--admin``, ``--superuser`` and
48+
``--active``, which change the corresponding attributes on ``BaseUser``.
49+
50+
For example:
51+
52+
.. code-block:: bash
53+
54+
piccolo user change_permissions some_user --active=true
55+
56+
The Piccolo Admin (see :ref:`Ecosystem`) uses these attributes to control who
57+
can login and what they can do.
58+
59+
* **active** and **admin** - must be true for a user to be able to login.
60+
* **superuser** - must be true for a user to be able to change other user's
61+
passwords.
62+
4463
-------------------------------------------------------------------------------
4564

4665
Within your code

0 commit comments

Comments
 (0)