auth0-oauth2-backend 1.0.4

1. Add this package to your project’s requirements

Add this project to your extra pip requirements.

OPENEDX_EXTRA_PIP_REQUIREMENTS:
  - git+https://github.com/blend-ed/auth0-oauth2-backend.git

2. Configure your Open edX LMS application

from tutor import hooks

hooks.Filters.ENV_PATCHES.add_items(
    [
        (
            "openedx-common-settings",
            """
            AUTH0_DOMAIN = "<YOUR_AUTH0_DOMAIN>"
            AUTH0_AUDIENCE = "<YOUR_AUTH0_AUDIENCE>"
            EMAIL_DOMAIN = "<Domain to be appended on the end of email (eg: email.com)>"
            TPA_AUTOMATIC_LOGOUT_ENABLED = True
            """,
        ),
        (
            "lms-env",
            """
            THIRD_PARTY_AUTH_BACKENDS: [
                "auth0_oauth2.auth0.Auth0OAuth2",
                "social_core.backends.google.GoogleOAuth2",
                "common.djangoapps.third_party_auth.saml.SAMLAuthBackend",
                "django.contrib.auth.backends.ModelBackend"
            ]
            SOCIAL_AUTH_AUTH0_PLUGIN_FIELDS_STORED_IN_SESSION:
            - "auth_entry"
            ADDL_INSTALLED_APPS:
            - "auth0_oauth2"
            """
        ),
        (
            "common-env-features",
            """
            ENABLE_THIRD_PARTY_AUTH: true
            """
        )
    ]
)

3. Configure your Auth0 provider configurations

This is the code to be placed in the other settings field:

{
  "DOMAIN": <Your Auth0 domain>,
  "DEFAULT_SCOPE": [
    "openid",
    "profile",
    "email"
  ],
  "logout_url": "https://YOUR_AUTHO_DOMAIN/logout?returnTo=YOUR_LMS_LOGOUT_URL"
}

4. Configure your Auth0 application in Auth0 dashboard

• Go to your Auth0 dashboard

• Click on settings and then go to the advanced settings

• Add the logout URL of your Open edX instance in the allowed logout URLs