diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/topics/auth.txt | 9 |
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 |