summaryrefslogtreecommitdiff
path: root/docs/ref/contrib/auth.txt
diff options
context:
space:
mode:
authorJoshua Cannon <joshua.cannon@ni.com>2018-12-13 10:14:03 -0600
committerTim Graham <timograham@gmail.com>2019-01-09 20:01:04 -0500
commitdb1b10ef0dcab2b8bacbea4adc681a57bd70b462 (patch)
tree98e5de16c2ba4a77d52bb0fc61c3b9b2da2f0473 /docs/ref/contrib/auth.txt
parent4ca2820ff573ed87c70fedda69efa8de23955669 (diff)
downloaddjango-db1b10ef0dcab2b8bacbea4adc681a57bd70b462.tar.gz
Fixed #30037 -- Added request arg to RemoteUserBackend.configure_user().
Diffstat (limited to 'docs/ref/contrib/auth.txt')
-rw-r--r--docs/ref/contrib/auth.txt11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/ref/contrib/auth.txt b/docs/ref/contrib/auth.txt
index 0dfa3a9261..efbffa62c2 100644
--- a/docs/ref/contrib/auth.txt
+++ b/docs/ref/contrib/auth.txt
@@ -611,13 +611,22 @@ The following backends are available in :mod:`django.contrib.auth.backends`:
information) prior to using it to get or create a user object. Returns
the cleaned username.
- .. method:: configure_user(user)
+ .. method:: configure_user(request, user)
Configures a newly created user. This method is called immediately
after a new user is created, and can be used to perform custom setup
actions, such as setting the user's groups based on attributes in an
LDAP directory. Returns the user object.
+ ``request`` is an :class:`~django.http.HttpRequest` and may be ``None``
+ if it wasn't provided to :func:`~django.contrib.auth.authenticate`
+ (which passes it on to the backend).
+
+ .. versionchanged:: 2.2
+
+ The ``request`` argument was added. Support for method overrides
+ that don't accept it will be removed in Django 3.1.
+
.. method:: user_can_authenticate()
Returns whether the user is allowed to authenticate. This method