Skip to main content

OAuthenticator: Authenticate JupyterHub users with common OAuth providers

Project description

OAuth + JupyterHub Authenticator = OAuthenticator :heart:

Documentation build status GitHub Workflow Status 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:

$ pip install --upgrade --pre -r test-requirements.txt
$ pytest -v ./oauthenticator/tests/

Or you run a specific test file with:

$ pytest -v ./oauthenticator/tests/<test-file-name>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oauthenticator-14.2.0.tar.gz (44.9 kB view details)

Uploaded Source

Built Distribution

oauthenticator-14.2.0-py3-none-any.whl (61.5 kB view details)

Uploaded Python 3

File details

Details for the file oauthenticator-14.2.0.tar.gz.

File metadata

  • Download URL: oauthenticator-14.2.0.tar.gz
  • Upload date:
  • Size: 44.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.11

File hashes

Hashes for oauthenticator-14.2.0.tar.gz
Algorithm Hash digest
SHA256 4baa02ff2c159cbba06f8d07fe11a6e624285ca2f813b1258b4c68766c0ee46b
MD5 31d28825336718b4b2f0070267179a0c
BLAKE2b-256 cfe8819c155bccafaf4c2af45ff44a1bdfbbc6ed9e3a48fde10349b30450f1ab

See more details on using hashes here.

Provenance

File details

Details for the file oauthenticator-14.2.0-py3-none-any.whl.

File metadata

  • Download URL: oauthenticator-14.2.0-py3-none-any.whl
  • Upload date:
  • Size: 61.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.11

File hashes

Hashes for oauthenticator-14.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3bf837d20108610364fa2c3e78f25fabad7322919c46534267d79a84dda8fd4b
MD5 6d9975d427acc4fb74cd0314d39ed612
BLAKE2b-256 2a84e3400b079f070374acef93dee71ab6203babf0263934eb77f6016b780007

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page