Skip to content

jupyterhub/oauthenticator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ba14061 · Jun 13, 2023
Jun 1, 2023
Apr 23, 2023
May 20, 2022
Jun 13, 2023
May 14, 2021
May 17, 2021
Jan 18, 2023
Jun 6, 2023
Jan 17, 2023
Apr 5, 2023
Aug 26, 2017
May 20, 2022
Apr 17, 2023
Jan 10, 2022
Apr 12, 2023
Mar 12, 2023
Apr 5, 2023

Repository files navigation

OAuth + JupyterHub Authenticator = OAuthenticator ❤️

Documentation build status GitHub Workflow Status - Test Latest PyPI version Latest conda-forge version GitHub Discourse Gitter

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, Okpy, 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>