Update docs on serializer customization (#668)

* Update simplejwt settings in * Update documentation on customizing token claims.
jazzband · Feb 14, 2023 · b0b8d1e · b0b8d1e
1 parent 063e5a2
commit b0b8d1e
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 31 deletions.
diff --git a/docs/customizing_token_claims.rst b/docs/customizing_token_claims.rst
@@ -25,8 +25,16 @@ generated by the ``TokenObtainPairView``:
 
           return token
 
-  class MyTokenObtainPairView(TokenObtainPairView):
-      serializer_class = MyTokenObtainPairSerializer
+.. code-block:: python
+
+  # Django project settings.py
+  ...
+
+  SIMPLE_JWT = {
+    # It will work instead of the default serializer(TokenObtainPairSerializer).
+    "TOKEN_OBTAIN_SERIALIZER": "rest_framework_simplejwt.serializers.MyTokenObtainPairSerializer",
+    # ...
+  }
 
 Note that the example above will cause the customized claims to be present in
 both refresh *and* access tokens which are generated by the view.  This follows

diff --git a/docs/settings.rst b/docs/settings.rst
@@ -14,35 +14,43 @@ Some of Simple JWT's behavior can be customized through settings variables in
   ...
 
   SIMPLE_JWT = {
-      'ACCESS_TOKEN_LIFETIME': timedelta(minutes=5),
-      'REFRESH_TOKEN_LIFETIME': timedelta(days=1),
-      'ROTATE_REFRESH_TOKENS': False,
-      'BLACKLIST_AFTER_ROTATION': False,
-      'UPDATE_LAST_LOGIN': False,
-
-      'ALGORITHM': 'HS256',
-      'SIGNING_KEY': SECRET_KEY,
-      'VERIFYING_KEY': None,
-      'AUDIENCE': None,
-      'ISSUER': None,
-      'JWK_URL': None,
-      'LEEWAY': 0,
-
-      'AUTH_HEADER_TYPES': ('Bearer',),
-      'AUTH_HEADER_NAME': 'HTTP_AUTHORIZATION',
-      'USER_ID_FIELD': 'id',
-      'USER_ID_CLAIM': 'user_id',
-      'USER_AUTHENTICATION_RULE': 'rest_framework_simplejwt.authentication.default_user_authentication_rule',
-
-      'AUTH_TOKEN_CLASSES': ('rest_framework_simplejwt.tokens.AccessToken',),
-      'TOKEN_TYPE_CLAIM': 'token_type',
-      'TOKEN_USER_CLASS': 'rest_framework_simplejwt.models.TokenUser',
-
-      'JTI_CLAIM': 'jti',
-
-      'SLIDING_TOKEN_REFRESH_EXP_CLAIM': 'refresh_exp',
-      'SLIDING_TOKEN_LIFETIME': timedelta(minutes=5),
-      'SLIDING_TOKEN_REFRESH_LIFETIME': timedelta(days=1),
+      "ACCESS_TOKEN_LIFETIME": timedelta(minutes=5),
+      "REFRESH_TOKEN_LIFETIME": timedelta(days=1),
+      "ROTATE_REFRESH_TOKENS": False,
+      "BLACKLIST_AFTER_ROTATION": False,
+      "UPDATE_LAST_LOGIN": False,
+
+      "ALGORITHM": "HS256",
+      "SIGNING_KEY": settings.SECRET_KEY,
+      "VERIFYING_KEY": "",
+      "AUDIENCE": None,
+      "ISSUER": None,
+      "JSON_ENCODER": None,
+      "JWK_URL": None,
+      "LEEWAY": 0,
+
+      "AUTH_HEADER_TYPES": ("Bearer",),
+      "AUTH_HEADER_NAME": "HTTP_AUTHORIZATION",
+      "USER_ID_FIELD": "id",
+      "USER_ID_CLAIM": "user_id",
+      "USER_AUTHENTICATION_RULE": "rest_framework_simplejwt.authentication.default_user_authentication_rule",
+
+      "AUTH_TOKEN_CLASSES": ("rest_framework_simplejwt.tokens.AccessToken",),
+      "TOKEN_TYPE_CLAIM": "token_type",
+      "TOKEN_USER_CLASS": "rest_framework_simplejwt.models.TokenUser",
+
+      "JTI_CLAIM": "jti", 
+
+      "SLIDING_TOKEN_REFRESH_EXP_CLAIM": "refresh_exp",
+      "SLIDING_TOKEN_LIFETIME": timedelta(minutes=5),
+      "SLIDING_TOKEN_REFRESH_LIFETIME": timedelta(days=1),
+
+      "TOKEN_OBTAIN_SERIALIZER": "rest_framework_simplejwt.serializers.TokenObtainPairSerializer",
+      "TOKEN_REFRESH_SERIALIZER": "rest_framework_simplejwt.serializers.TokenRefreshSerializer",
+      "TOKEN_VERIFY_SERIALIZER": "rest_framework_simplejwt.serializers.TokenVerifySerializer",
+      "TOKEN_BLACKLIST_SERIALIZER": "rest_framework_simplejwt.serializers.TokenBlacklistSerializer",
+      "SLIDING_TOKEN_OBTAIN_SERIALIZER": "rest_framework_simplejwt.serializers.TokenObtainSlidingSerializer",
+      "SLIDING_TOKEN_REFRESH_SERIALIZER": "rest_framework_simplejwt.serializers.TokenRefreshSlidingSerializer",
   }
 
 Above, the default values for these settings are shown.