diff options
Diffstat (limited to 'docs/ref/contrib/auth.txt')
| -rw-r--r-- | docs/ref/contrib/auth.txt | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/docs/ref/contrib/auth.txt b/docs/ref/contrib/auth.txt index 40c3c84e75..abcf3905c9 100644 --- a/docs/ref/contrib/auth.txt +++ b/docs/ref/contrib/auth.txt @@ -649,17 +649,27 @@ 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(request, user) + .. method:: configure_user(request, user, created=True) - 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. + Configures the user on each authentication attempt. This method is + called immediately after fetching or creating the user being + authenticated, 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. + + The setup can be performed either once when the user is created + (``created`` is ``True``) or on existing users (``created`` is + ``False``) as a way of synchronizing attributes between the remote and + the local systems. ``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:: 4.1 + + The ``created`` argument was added. + .. method:: user_can_authenticate() Returns whether the user is allowed to authenticate. This method |