Browse files

[1.0.X] Fixed #7011 -- Clarified what User.is_active really means in …

…the documentation.

Backport of r9176 from trunk.

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
1 parent 378dadc commit 6a30f5a2ea120d143b457a612ab9f1d1236256b6 @malcolmt malcolmt committed Oct 6, 2008
Showing with 9 additions and 2 deletions.
  1. +9 −2 docs/topics/auth.txt
11 docs/topics/auth.txt
@@ -89,8 +89,15 @@ Fields
.. attribute:: models.User.is_active
- Boolean. Designates whether this account can be used to log in. Set this
- flag to ``False`` instead of deleting accounts.
+ Boolean. Designates whether this user account should be considered
+ active. Set this flag to ``False`` instead of deleting accounts.
+ This doesn't control whether or not the user can log in. Nothing in
+ the authentication path checks the ``is_active`` flag, so if you want
+ to reject a login based on ``is_active`` being ``False``, it is up to
+ you to check that in your own login view. However, permission checking
+ using the methods like :meth:`~models.User.has_perm` does check this
+ flag and will always return ``False`` for inactive users.
.. attribute:: models.User.is_superuser

0 comments on commit 6a30f5a

Please sign in to comment.