Skip to content

Commit

Permalink
Merge pull request #20 from andreyyudin/feature/new-backend
Browse files Browse the repository at this point in the history
Added the documentation of ORCID backend
  • Loading branch information
omab committed May 28, 2017
2 parents 9dfe9c6 + 75ebf47 commit 5a67de4
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/backends/orcid.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
ORCID
===============================

ORCID_ uses OAuth 2 for authentication.

- Register an ORCID account, go to `Developer tools`_, enable the public API,
create a new application, set the redirect URI to
``http://example.com/complete/orcid/`` replacing ``example.com`` with your
domain.

- Fill the ``Client ID`` and ``Client secret`` values from the app details in
`Developer tools` (you might need to press "Show details") in the settings::

SOCIAL_AUTH_ORCID_KEY = ''
SOCIAL_AUTH_ORCID_SECRET = ''


Sandbox
-------

ORCID supports a sandbox mode for testing, there's a custom backend for it
which name is ``orcid-sandbox`` instead of ``orcid``. Same settings apply
but use these instead::

SOCIAL_AUTH_ORCID_SANDBOX_KEY = ''
SOCIAL_AUTH_ORCID_SANDBOX_SECRET = ''

.. _ORCID: https://orcid.org/
.. _Developer tools: https://orcid.org/developer-tools

0 comments on commit 5a67de4

Please sign in to comment.