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, 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.0.0.tar.gz (42.2 kB view details)

Uploaded Source

Built Distribution

oauthenticator-14.0.0-py3-none-any.whl (58.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oauthenticator-14.0.0.tar.gz
  • Upload date:
  • Size: 42.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.9

File hashes

Hashes for oauthenticator-14.0.0.tar.gz
Algorithm Hash digest
SHA256 99740548a58f47c391e2468e8d18fd72b2e0fa9ba65febcec34dd184dba0ccfd
MD5 9f5e91535ddc65f4c97925683f1e41d3
BLAKE2b-256 d650eabe5fb4878742041ca12d13fec7d3e4dadace3c230f1e9e23b7a2fdc3b5

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: oauthenticator-14.0.0-py3-none-any.whl
  • Upload date:
  • Size: 58.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.9

File hashes

Hashes for oauthenticator-14.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6c61de1a73a5db539d68fc7be2e5d65af08679ed8c1af36ff95d54ec15562324
MD5 5bfc7da6e04ed13f4c612b5c5e13e9c4
BLAKE2b-256 1e0d1e75bafa20b57e9003afe41817a378ee6aaa6c72d7fa1aa0b1cd7b62fff8

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