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 - Test 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, 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, first setup a development environment as described in CONTRIBUTING.md, and then do:

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

Uploaded Source

Built Distribution

oauthenticator-16.3.0-py3-none-any.whl (77.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oauthenticator-16.3.0.tar.gz
  • Upload date:
  • Size: 59.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for oauthenticator-16.3.0.tar.gz
Algorithm Hash digest
SHA256 40c75d18951f69f5e80713028e5c75947e396b805a6f700fe23f0fc7b27161a4
MD5 b2a9fab2d46778efb1aad328012f3707
BLAKE2b-256 968092b1abbbf30067282ea38021ebcf8cde19b74bd4e93079b19fffe8278adc

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for oauthenticator-16.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8ae919d6d96a9f8147e46e15ee8127dc36661d36e4f9bce5132de726049c7574
MD5 7966f13988e16d97931f507909ef219c
BLAKE2b-256 e2ea506d90f2697e3fb2efe06f775a35cf7babbf4a3be3c3889227a6fccc5914

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