Skip to main content

Open Learning Social Auth

An Open edX plugin implementing MIT social auth backend

Version Compatibility

Compatible with all edx releases

For this plugin’s compatibility with Open edX, see the Open edX Release Compatibility table.

Installing The Plugin

For detailed installation instructions, please refer to the plugin installation guide.

Installation required in:

  • LMS

Configurations

This section outlines the steps for integrating your application with ol-social-auth for various deployment scenarios. Please refer to the corresponding documentation for detailed instructions.

  • Devstack: To configure ol-social-auth with an edx-platform instance provisioned using devstack, follow the instructions here

  • Tutor: To configure ol-social-auth with an edx-platform instance provisioned using tutor, follow the instructions here also

How to use

Make sure to properly configure the plugin following the links in the above “Configurations” section before use.

  • Install the plugin in the lms following the installation steps above.

  • Verify that you are not logged in on edx-platform.

  • Create a new user in your MIT application and verify that a corresponding user is successfully created on the edX platform.

Expired Token Cleanup

This plugin includes a scheduled Celery task (ol_clear_expired_tokens) that automatically removes expired OAuth2 access tokens, refresh tokens, and grant tokens from the database.

Behavior:

  • Runs every Monday at 9:00 AM (server time) via Celery Beat by default. The schedule can be customized by overriding the ol_clear_expired_tokens entry in CELERYBEAT_SCHEDULE.

  • Uses django-oauth-toolkit’s clear_expired() to delete tokens that have exceeded the configured expiration threshold.

  • Sets REFRESH_TOKEN_EXPIRE_SECONDS to 30 days (overriding the edx-platform default of 90 days). Tokens revoked or expired longer than 30 days ago will be cleaned up.

Note: If running this plugin for the first time on a database with a large backlog of expired tokens (millions of rows), consider running the edx_clear_expired_tokens management command manually first to reduce the initial volume before relying on the scheduled task.

Metadata

Release files for ol-social-auth 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ol-social-auth 0.3.1
File Size Uploaded Provenance Actions
ol_social_auth-0.3.1.tar.gz 4.9 kB Without provenance Details for ol_social_auth-0.3.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ol-social-auth 0.3.1
File Interpreter ABI Platform Actions
ol_social_auth-0.3.1-py3-none-any.whl Python 3 none any Details for ol_social_auth-0.3.1-py3-none-any.whl

Total release size: 12.0 kB

Release files / ol_social_auth-0.3.1.tar.gz

Download URL ol_social_auth-0.3.1.tar.gz
Size 4.9 kB
Tags Source
SHA-256 checksum
How to use checksums
86afd27a5c63594414a10d0ab09644ec056c4ec46c7b81eb564afab075485ee0
BLAKE2b-256 checksum
How to use checksums
46e0bd119f25f7935a4833eca4cf373389113c46df5f8ac729994f6862de65da
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Release files / ol_social_auth-0.3.1-py3-none-any.whl

Download URL ol_social_auth-0.3.1-py3-none-any.whl
Size 7.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
45e4d4227a006d5df95f4ff008f495722ae170fd877eb775c1bcb9191c662f78
BLAKE2b-256 checksum
How to use checksums
a64fd61d141e22e6f262c00102d61624c12ef23643e94b0be24210a413d1d679
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Security for ol-social-auth 0.3.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page