Skip to content

Commit

Permalink
Update refresh_access_token method docstring #12
Browse files Browse the repository at this point in the history
  • Loading branch information
VKTB committed Feb 1, 2024
1 parent 14aaae6 commit ddf3c92
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions ldap_jwt_auth/auth/jwt_handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,12 @@ def get_refresh_token(self) -> str:
def refresh_access_token(self, access_token: str, refresh_token: str):
"""
Refreshes the JWT access token by updating its expiry time, provided that the JWT refresh token is valid.
Before attempting to refresh the token, it checks that the username is still part of the active usernames.
:param access_token: The JWT access token to refresh.
:param refresh_token: The JWT refresh token.
:raises JWTRefreshError: If the JWT access token cannot be refreshed.
:raises UserNotActiveError: If the username is no longer part of the active usernames.
:return: JWT access token with an updated expiry time.
"""
logger.info("Refreshing access token")
Expand Down

0 comments on commit ddf3c92

Please sign in to comment.