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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: oauthenticator-15.0.0.tar.gz
  • Upload date:
  • Size: 48.7 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.0.tar.gz
Algorithm Hash digest
SHA256 775b68620aee7e755dd744212789e142ac8345aab80a358b0e30beec004da7a6
MD5 8dfca2cb263d67017712a4876ca50d64
BLAKE2b-256 16a5cf60dd5f2387686c18c580d21fa1dc6074747703402c57adae2342920aa3

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for oauthenticator-15.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 67afd0b3685ec790002301f3a218c55ff31bb2a226d804df96663b2c1c01268b
MD5 bfa048a0efb01fe294f2670f187a09f5
BLAKE2b-256 4e36b26ff8fbf3eefbd5232b8b8725a95364bc32cc90e9323d550d1c2f9713b3

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