diff --git a/docs/settings.rst b/docs/settings.rst index c0c674963..c2c4813a4 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -35,6 +35,7 @@ Some of Simple JWT's behavior can be customized through settings variables in 'AUTH_TOKEN_CLASSES': ('rest_framework_simplejwt.tokens.AccessToken',), 'TOKEN_TYPE_CLAIM': 'token_type', + 'TOKEN_USER_CLASS': 'rest_framework_simplejwt.models.TokenUser', 'JTI_CLAIM': 'jti', @@ -215,6 +216,14 @@ identifier is used to identify revoked tokens in the blacklist app. It may be necessary in some cases to use another claim besides the default "jti" claim to store such a value. +``TOKEN_USER_CLASS`` +-------------------- + +A stateless user object which is backed by a validated token. Used only for +the experimental JWTTokenUserAuthentication authentication backend. The value +is a dotted path to your subclass of ``rest_framework_simplejwt.models.TokenUser``, +which also is the default. + ``SLIDING_TOKEN_LIFETIME`` --------------------------