hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-13 21:13:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

authenticator reference doc: update authenticate return

Browse Source
This commit is contained in:
Simon Li
2023-11-16 19:16:54 +00:00
parent 29bb4b8032
commit 99d72dfccf
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/source/reference/authenticators.md
View File

@@ -65,11 +65,15 @@ from JupyterHub's login form. Unless the login form has been customized,
- `username`
- `password`
The `authenticate` method's job is simple:
If authentication is successful the `authenticate` method must return either:
- return the username (non-empty str) of the authenticated user if
authentication is successful
- return `None` otherwise
- the username (non-empty str) of the authenticated user
- or a dictionary with fields:
- `name`: the username
- `auth_state`: optional, a dictionary of of [auth state that will be persisted](authenticator-auth-state)
- `groups`: optional, a list of JupyterHub [group memberships](authenticator-groups)
Otherwise, it must return `None`.
Writing an Authenticator that looks up passwords in a dictionary
requires only overriding this one method:
@@ -182,6 +186,8 @@ Additionally, configurable attributes for your authenticator will
appear in jupyterhub help output and auto-generated configuration files
via `jupyterhub --generate-config`.
(authenticator-auth-state)=
### Authentication state
JupyterHub 0.8 adds the ability to persist state related to authentication,