Skip to content

docs: Add README for third_party_auth. #35608

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dianakhuang merged 1 commit into from
Oct 7, 2024
Merged

docs: Add README for third_party_auth. #35608

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions common/djangoapps/third_party_auth/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Third Party Auth
----------------

This djangoapp provides the views and workflows for authenticating into edx-platform with third-party applications, including both OAuth and SAML workflows.

We make use of the `social-auth-app-django`_ as our backend library for this djangoapp.

To enable this feature, check out the `third party authentication documentation`.

.. _social-auth-app-django: https://github.com/python-social-auth/social-app-django
.. _third party authentication documentation: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/tpa/index.html