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

Uploaded Source

Built Distribution

oauthenticator-15.1.0-py3-none-any.whl (66.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for oauthenticator-15.1.0.tar.gz
Algorithm Hash digest
SHA256 d1d9873c9b66e1af973291968b9573d25378bd8c647f30d73b8d8fb27b1a0b85
MD5 384867df03d3141b7683d0f591a33538
BLAKE2b-256 1fa00fc870a69dacb2187d6508bdfc78bc4cf53bbc78527cf3f8ede890354aff

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for oauthenticator-15.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ad1b0da201f2bf2ab0b97a90ec350ddaefc7e9909ddb7e4f22c1d15b42f19b21
MD5 25dbcc06b4b70301b9c0ed016dec066d
BLAKE2b-256 dc6b6d929c788bf5fb66618dc8cf4ac2db453159cd3dbafc1c86d62dc26ae358

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