summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPreston Holmes <preston@ptone.com>2012-10-04 10:14:50 -0700
committerPreston Holmes <preston@ptone.com>2012-10-28 23:06:09 -0700
commitf427ecdc88f71bbd2e8590da514e59c37c453217 (patch)
treefb800b82d36f89651daf8788e0c4ec8981ecaee6 /docs
parentb4627bcabe6704c5bd1cbfb2d3a1421e05c29cd7 (diff)
[1.5.x] Fixed #19061 -- added is_active attribute to AbstractBaseUser
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/auth.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/topics/auth.txt b/docs/topics/auth.txt
index d261a3c90b..f7a9084008 100644
--- a/docs/topics/auth.txt
+++ b/docs/topics/auth.txt
@@ -1911,6 +1911,15 @@ password resets. You must then provide some key implementation details:
``REQUIRED_FIELDS`` must contain all required fields on your User
model, but should *not* contain the ``USERNAME_FIELD``.
+ .. attribute:: User.is_active
+
+ A boolean attribute that indicates whether the user is considered
+ "active". This attribute is provided as an attribute on
+ ``AbstractBaseUser`` defaulting to ``True``. How you choose to
+ implement it will depend on the details of your chosen auth backends.
+ See the documentation of the :attr:`attribute on the builtin user model
+ <django.contrib.auth.models.User.is_active>` for details.
+
.. method:: User.get_full_name():
A longer formal identifier for the user. A common interpretation