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-15.0.1.tar.gz (48.8 kB view details)

Uploaded Source

Built Distribution

oauthenticator-15.0.1-py3-none-any.whl (65.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oauthenticator-15.0.1.tar.gz
  • Upload date:
  • Size: 48.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for oauthenticator-15.0.1.tar.gz
Algorithm Hash digest
SHA256 2e30bf2f2df040be798230b2a1666292f2ba072892d4212c6572b4fe59b39860
MD5 77f7945319ad49f8f9ea4f5a5f7fb6b8
BLAKE2b-256 338cbc3e656c3e76d19fe87c52fd52249127532307f4943cb0b961ee0a9eaa3c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for oauthenticator-15.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c34db993bbcb1639f9e9929fa51cf151866e784bc215b2e686cee8b44931482c
MD5 af91d5e58719414198a18e2badf610e4
BLAKE2b-256 a4160428c43fd5a3769883373593ec4a1511378189f6465da95990dc538a343d

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