API Reference
=============

This reference covers the main extension points provided by ``social-auth-core``.
The generated pages include links to the corresponding source code.

Authentication backends
-----------------------

.. automodule:: social_core.backends.base
   :members:
   :undoc-members:
   :exclude-members: get_user_details
   :show-inheritance:

.. automodule:: social_core.backends.oauth
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: social_core.backends.open_id
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: social_core.backends.open_id_connect
   :members:
   :undoc-members:
   :exclude-members: get_user_details
   :show-inheritance:

Pipeline
--------

.. automodule:: social_core.pipeline.social_auth
   :members:
   :undoc-members:

.. automodule:: social_core.pipeline.user
   :members:
   :undoc-members:

.. automodule:: social_core.pipeline.mail
   :members:
   :undoc-members:

Framework integration
---------------------

.. automodule:: social_core.strategy
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: social_core.storage
   :members:
   :undoc-members:
   :show-inheritance:

Errors and utilities
--------------------

.. automodule:: social_core.exceptions
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: social_core.utils
   :members:
   :undoc-members: