From 476cb6bef686cd2161393f908082caa7e998036e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20=C4=8Ciha=C5=99?= Date: Thu, 8 Oct 2026 09:36:35 +0200 Subject: [PATCH] docs(backends): remove obsolete authentication setup guides Remove setup instructions and provider listings for Live Connect, Evernote Sandbox, PixelPin, Behance, and ActionID OpenID to match the retired or unavailable integrations removed from social-core. Keep production Evernote documentation. Refs python-social-auth/social-core#1176 --- docs/backends/behance.rst | 46 ---------------------------- docs/backends/evernote.rst | 24 ++++----------- docs/backends/index.rst | 4 --- docs/backends/live.rst | 39 ----------------------- docs/backends/ngpvan_actionid.rst | 51 ------------------------------- docs/backends/pixelpin.rst | 48 ----------------------------- docs/intro.rst | 6 ---- 7 files changed, 6 insertions(+), 212 deletions(-) delete mode 100644 docs/backends/behance.rst delete mode 100644 docs/backends/live.rst delete mode 100644 docs/backends/ngpvan_actionid.rst delete mode 100644 docs/backends/pixelpin.rst diff --git a/docs/backends/behance.rst b/docs/backends/behance.rst deleted file mode 100644 index 1aac4f1e..00000000 --- a/docs/backends/behance.rst +++ /dev/null @@ -1,46 +0,0 @@ -Behance -======= - -Backend class -------------- - -For Django, add this class path to ``AUTHENTICATION_BACKENDS``. For other -integrations, use the same class path in the framework-specific backend -setting. - -.. list-table:: - :header-rows: 1 - - * - Backend name - - Class path - * - ``behance`` - - ``social_core.backends.behance.BehanceOAuth2`` - -DEPRECATED NOTICE ------------------ - -**NOTE:** IT SEEMS THAT BEHANCE HAS DROPPED THEIR OAUTH2 SUPPORT WITHOUT MUCH -NOTICE BESIDE A `BLOG POST`_ ON SEPTEMBER 2014 MENTIONING THAT IT WILL BE -INTRODUCED "SOON". THIS BACKEND IS IN DEPRECATED STATE FOR NOW. - -Behance uses OAuth2 for its auth mechanism. - -- Register a new application at `Behance App Registration`_, set your - application name, website and redirect URI. - -- Fill ``Client Id`` and ``Client Secret`` values in the settings:: - - SOCIAL_AUTH_BEHANCE_KEY = '' - SOCIAL_AUTH_BEHANCE_SECRET = '' - -- Also it's possible to define extra permissions with:: - - SOCIAL_AUTH_BEHANCE_SCOPE = [...] - -Check available permissions at `Possible Scopes`_. Also check the rest of their -doc at `Behance Developer Documentation`_. - -.. _Behance App Registration: http://www.behance.net/dev/register -.. _Possible Scopes: http://www.behance.net/dev/authentication#scopes -.. _Behance Developer Documentation: http://www.behance.net/dev -.. _BLOG POST: http://blog.behance.net/dev/introducing-the-behance-api diff --git a/docs/backends/evernote.rst b/docs/backends/evernote.rst index 446f8412..cd5cac9d 100644 --- a/docs/backends/evernote.rst +++ b/docs/backends/evernote.rst @@ -1,12 +1,12 @@ Evernote OAuth ============== -Backend classes ---------------- +Backend class +------------- -For Django, choose from these class paths for ``AUTHENTICATION_BACKENDS``. -For other integrations, use the same class paths in the -framework-specific backend setting. +For Django, add this class path to ``AUTHENTICATION_BACKENDS``. For other +integrations, use the same class path in the framework-specific backend +setting. .. list-table:: :header-rows: 1 @@ -15,10 +15,8 @@ framework-specific backend setting. - Class path * - ``evernote`` - ``social_core.backends.evernote.EvernoteOAuth`` - * - ``evernote-sandbox`` - - ``social_core.backends.evernote.EvernoteSandboxOAuth`` -Evernote OAuth 1.0 for its authentication workflow. +Evernote uses OAuth 1.0 for its production authentication workflow. - Register a new application at `Evernote API Key form`_. @@ -28,14 +26,4 @@ Evernote OAuth 1.0 for its authentication workflow. SOCIAL_AUTH_EVERNOTE_SECRET = '' -Sandbox -------- - -Evernote supports a sandbox mode for testing, there's a custom backend for it -which name is ``evernote-sandbox`` instead of ``evernote``. Same settings apply -but use these instead:: - - SOCIAL_AUTH_EVERNOTE_SANDBOX_KEY = '' - SOCIAL_AUTH_EVERNOTE_SANDBOX_SECRET = '' - .. _Evernote API Key form: http://dev.evernote.com/support/api_key.php diff --git a/docs/backends/index.rst b/docs/backends/index.rst index 08e4195b..be5f5a92 100644 --- a/docs/backends/index.rst +++ b/docs/backends/index.rst @@ -55,7 +55,6 @@ Social backends auth0_openidconnect azuread battlenet - behance belgium_eid bitbucket bitbucket_datacenter_oauth2 @@ -107,7 +106,6 @@ Social backends line linkedin livejournal - live loginradius lyft mailchimp @@ -122,7 +120,6 @@ Social backends nationbuilder naver nfdi - ngpvan_actionid odnoklassnikiru okta openstreetmap_oauth2 @@ -132,7 +129,6 @@ Social backends osso patreon pinterest - pixelpin podio qiita qq diff --git a/docs/backends/live.rst b/docs/backends/live.rst deleted file mode 100644 index de5f333a..00000000 --- a/docs/backends/live.rst +++ /dev/null @@ -1,39 +0,0 @@ -MSN Live Connect -================ - -Backend class -------------- - -For Django, add this class path to ``AUTHENTICATION_BACKENDS``. For other -integrations, use the same class path in the framework-specific backend -setting. - -.. list-table:: - :header-rows: 1 - - * - Backend name - - Class path - * - ``live`` - - ``social_core.backends.live.LiveOAuth2`` - -Live uses OAuth2 for its connect workflow, notice that it isn't OAuth WRAP. - -- Register a new application at `Live Connect Developer Center`_, set your site - domain as redirect domain, - -- Fill ``Client Id`` and ``Client Secret`` values in the settings:: - - SOCIAL_AUTH_LIVE_KEY = '' - SOCIAL_AUTH_LIVE_SECRET = '' - -- Also it's possible to define extra permissions with:: - - SOCIAL_AUTH_LIVE_SCOPE = [...] - - Defaults are ``wl.basic`` and ``wl.emails``. Latter one is necessary to - retrieve user email. - -- Ensure to have a valid ``Redirect URL`` (``http://your-domain/complete/live``) - defined in the application if ``Enhanced security redirection`` is enabled. - -.. _Live Connect Developer Center: https://account.live.com/developers/applications/create diff --git a/docs/backends/ngpvan_actionid.rst b/docs/backends/ngpvan_actionid.rst deleted file mode 100644 index 002160ff..00000000 --- a/docs/backends/ngpvan_actionid.rst +++ /dev/null @@ -1,51 +0,0 @@ -NGP VAN ActionID -================ - -Backend class -------------- - -For Django, add this class path to ``AUTHENTICATION_BACKENDS``. For other -integrations, use the same class path in the framework-specific backend -setting. - -.. list-table:: - :header-rows: 1 - - * - Backend name - - Class path - * - ``actionid-openid`` - - ``social_core.backends.ngpvan.ActionIDOpenID`` - -`NGP VAN`_'s ActionID_ service provides an OpenID 1.1 endpoint, which provides -first name, last name, email address, and phone number. - -ActionID doesn't require major settings beside being defined on -``AUTHENTICATION_BACKENDS`` - -.. code-block:: python - - SOCIAL_AUTH_AUTHENTICATION_BACKENDS = ( - ... - 'social_core.backends.ngpvan.ActionIDOpenID', - ... - ) - - -If you want to be able to access the "phone" attribute offered by NGP VAN -within ``extra_data`` you can add the following to your settings: - -.. code-block:: python - - SOCIAL_AUTH_ACTIONID_OPENID_AX_EXTRA_DATA = [ - ('http://openid.net/schema/contact/phone/business', 'phone') - ] - - -NGP VAN offers the ability to have your domain whitelisted, which will disable -the "{domain} is requesting a link to your ActionID" warning when your app -attempts to login using an ActionID account. Contact -`NGP VAN Developer Support`_ for more information - -.. _NGP VAN: http://www.ngpvan.com/ -.. _ActionID: http://developers.ngpvan.com/action-id -.. _NGP VAN Developer Support: http://developers.ngpvan.com/support/contact diff --git a/docs/backends/pixelpin.rst b/docs/backends/pixelpin.rst deleted file mode 100644 index 1e953f39..00000000 --- a/docs/backends/pixelpin.rst +++ /dev/null @@ -1,48 +0,0 @@ -PixelPin -======== - -Backend class -------------- - -For Django, add this class path to ``AUTHENTICATION_BACKENDS``. For other -integrations, use the same class path in the framework-specific backend -setting. - -.. list-table:: - :header-rows: 1 - - * - Backend name - - Class path - * - ``pixelpin-openidconnect`` - - ``social_core.backends.pixelpin.PixelPinOpenIDConnect`` - -PixelPin supports OpenID Connect. - -PixelPin OpenID Connect ------------------------ - -Developer documentation for PixelPin can be found at -http://developer.pixelpin.co.uk/. To setup OpenID Connect do the following: - -- Register a new developer account at `PixelPin Developers`_. - - You require a PixelPin account to create developer accounts. Sign up at - `PixelPin Account Page`_ For the value of redirect uri, use whatever path you - need to return to on your web application. The example code provided with the - plugin uses ``http:///complete/pixelpin-oauth2/``. - - Once verified by email, record the values of client id and secret for the - next step. - -- Fill **Consumer Key** and **Consumer Secret** values in your settings.py - file:: - - SOCIAL_AUTH_PIXELPIN_OAUTH2_KEY = '' - SOCIAL_AUTH_PIXELPIN_OAUTH2_SECRET = '' - -- Add ``'social_core.backends.pixelpin.PixelPinOpenIDConnect'`` into your - ``SOCIAL_AUTH_AUTHENTICATION_BACKENDS``. - -.. _PixelPin homepage: http://pixelpin.co.uk/ -.. _PixelPin Account Page: https://login.pixelpin.co.uk/ -.. _PixelPin Developers: http://developer.pixelpin.co.uk/ diff --git a/docs/intro.rst b/docs/intro.rst index 25c60f92..37f4efb8 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -35,7 +35,6 @@ Several supported service by simple backends definition (easy to add new ones or extend current one): * Angel_ OAuth2 -* Behance_ OAuth2 * Bitbucket_ OAuth1 * Box_ OAuth2 * Dailymotion_ OAuth2 @@ -56,12 +55,10 @@ or extend current one): * Kakao_ OAuth2 * Keycloak_ OpenID * Linkedin_ OAuth1 -* Live_ OAuth2 * Livejournal_ OpenID * Mailru_ OAuth2 * MineID_ OAuth2 * Mixcloud_ OAuth2 -* `NGPVAN ActionID`_ OpenID * Odnoklassniki_ OAuth2 and Application Auth * OpenID_ * Podio_ OAuth2 @@ -114,7 +111,6 @@ section. .. _OAuth: http://oauth.net/ .. _myOpenID: https://www.myopenid.com/ .. _Angel: https://angel.co -.. _Behance: https://www.behance.net .. _Bitbucket: https://bitbucket.org .. _Box: https://www.box.com .. _Dailymotion: https://dailymotion.com @@ -135,12 +131,10 @@ section. .. _Kakao: https://kakao.com .. _Keycloak: https://www.keycloak.org .. _Linkedin: https://www.linkedin.com -.. _Live: https://www.live.com .. _Livejournal: http://livejournal.com .. _Mailru: https://mail.ru .. _MineID: https://www.mineid.org .. _Mixcloud: https://www.mixcloud.com -.. _NGPVAN ActionID: http://developers.ngpvan.com/action-id .. _Odnoklassniki: http://www.odnoklassniki.ru .. _Podio: https://podio.com .. _Shopify: http://shopify.com