OAuth + JupyterHub Authenticator = OAuthenticator :heart:
OAuth is a token based login mechanism that doesn't rely on a username and password mapping. In order to use this login mechanism with JupyerHub the login handlers need to be overridden. OAuthenticator overrides these handlers for the common OAuth2 identity providers allowing them to be plugged in and used with JupyterHub.
The following authentication services are supported through their own authenticator: Auth0, Azure AD, Bitbucket, CILogon, FeiShu, GitHub, GitLab, Globus, Google, MediaWiki, OpenShift.
There is also a GenericAuthenticator that can be configured with any OAuth 2.0 identity provider or can be used to create a new authenticator class when additional customization is needed.
Installation
The installation guide can be found in the docs.
The docs also provide example setups for different OAuth2 identity providers.
Running tests
To run the tests locally, first setup a development environment as described in CONTRIBUTING.md, and then do:
pytest -v ./oauthenticator/tests/
Or you run a specific test file with:
pytest -v ./oauthenticator/tests/<test-file-name>
6 maintainers
Release files for oauthenticator 17.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| oauthenticator-17.4.0.tar.gz | 208.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| oauthenticator-17.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 294.7 kB
Release files / oauthenticator-17.4.0.tar.gz
| Download URL | oauthenticator-17.4.0.tar.gz |
|---|---|
| Size | 208.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b1025d725dc406977299c87fedea2006fcabac3bea9d4e17f690d4dad044923e
|
|
BLAKE2b-256 checksum How to use checksums |
b255d0d2c37985c3272dd016b753296bb33d7b8e748ea009fdf0d85e3c1a867a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 26, 2026.
Transparency logRelease files / oauthenticator-17.4.0-py3-none-any.whl
| Download URL | oauthenticator-17.4.0-py3-none-any.whl |
|---|---|
| Size | 86.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2b59a8d71f0e2822fad243837eb325b4d12b365c6aedfd3cc88f73e9f00486e8
|
|
BLAKE2b-256 checksum How to use checksums |
adfbdc63bbec406e4dd7eecf1def43348ae27d94f9444e8a86d55af46e284080
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 26, 2026.
Transparency log
