From 296511699eae15b34896f1873fa7e5c2a9de9743 Mon Sep 17 00:00:00 2001 From: Min RK Date: Mon, 11 Nov 2024 10:19:34 +0100 Subject: [PATCH] mention that `auth_refresh_age = 0` disables time-based refresh_user --- jupyterhub/auth.py | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/jupyterhub/auth.py b/jupyterhub/auth.py index 84f5594b..1cac64b4 100644 --- a/jupyterhub/auth.py +++ b/jupyterhub/auth.py @@ -77,10 +77,16 @@ class Authenticator(LoggingConfigurable): help="""The max age (in seconds) of authentication info before forcing a refresh of user auth info. - Refreshing auth info allows, e.g. requesting/re-validating auth tokens. + Authenticators that support it may re-load managed groups, + refresh auth tokens, etc., or force a new login if auth info cannot be refreshed. - See :meth:`.refresh_user` for what happens when user auth info is refreshed - (nothing by default). + See :meth:`.refresh_user` for what happens when user auth info is refreshed, + which varies by authenticator. + If an Authenticator does not implement `refresh_user`, + auth info will never be considered stale. + + Set `auth_refresh_age = 0` to disable time-based calls to `refresh_user`. + You can still use :attr:`refresh_pre_spawn` if `auth_refresh_age` is disabled. """, )