Skip to content

Commit

Permalink
Add SOCIAL_AUTH_IMMUTABLE_USER_FIELDS to docs (#84)
Browse files Browse the repository at this point in the history
* Add new SOCIAL_AUTH_IMMUTABLE_USER_FIELDS setting to docs
* Minor tweak to formatting
  • Loading branch information
keithhackbarth committed Apr 27, 2021
1 parent d9393a0 commit 33a6a3c
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/configuration/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,16 @@ Miscellaneous settings
``email``, etc.), those fields need to be *protect*. Set any field name that
requires *protection* in this setting, and it won't be updated.


``SOCIAL_AUTH_IMMUTABLE_USER_FIELDS = ['email',]``
Set any field name that requires *protection* in this setting, and it won't
be updated after inital population. This setting is similar to
``SOCIAL_AUTH_PROTECTED_USER_FIELDS`` in that they both do not allow changes
of the data - however this one allows it to be set if no prior value exists.
An example use case might be an application that seeds data from a social
plaform but allows the users to override it locally.


``SOCIAL_AUTH_SESSION_EXPIRATION = False``
By default, user session expiration time will be set by your web
framework (in Django, for example, it is set with
Expand Down

0 comments on commit 33a6a3c

Please sign in to comment.