https://github.com/flavors/django-graphql-social-auth

Python Social Auth support for Graphene Django
https://github.com/flavors/django-graphql-social-auth

authentication django facebook graphene graphql jwt python-social-auth social-auth social-authentication twitter

Last synced: 17 days ago
JSON representation

Python Social Auth support for Graphene Django

• Host: GitHub
• URL: https://github.com/flavors/django-graphql-social-auth
• Owner: flavors
• License: mit
• Created: 2018-01-14T13:39:24.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-01-19T22:13:02.000Z (over 1 year ago)
• Last Synced: 2025-03-30T11:09:58.792Z (24 days ago)
• Topics: authentication, django, facebook, graphene, graphql, jwt, python-social-auth, social-auth, social-authentication, twitter
• Language: Python
• Homepage: https://pypi.python.org/pypi/django-graphql-social-auth
• Size: 54.7 KB
• Stars: 109
• Watchers: 8
• Forks: 33
• Open Issues: 18
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Django GraphQL Social Auth

==========================

|Pypi| |Wheel| |Build Status| |Codecov| |Code Climate|

`Python Social Auth`_ support for `Django GraphQL`_

.. _Django GraphQL: https://github.com/graphql-python/graphene-django

Dependencies

------------

* Python ≥ 3.4

* Django ≥ 1.11

Installation

------------

Install last stable version from Pypi.

.. code:: sh

    pip install django-graphql-social-auth

See the `documentation`_ for further guidance on setting *Python Social Auth*.

.. _documentation: http://python-social-auth.readthedocs.io/en/latest/configuration/django.html

Add the ``SocialAuth`` mutation to your GraphQL schema.

.. code:: python

    import graphene

    import graphql_social_auth

    class Mutations(graphene.ObjectType):

        social_auth = graphql_social_auth.SocialAuth.Field()

`Session`_ authentication via *accessToken*.

.. _Session: https://docs.djangoproject.com/en/2.0/topics/http/sessions/

- ``provider``: provider name from `Authentication backend list`_.

- ``accessToken``: third-party (Google, Facebook...) OAuth token obtained with any OAuth client.

.. _Authentication backend list: https://github.com/flavors/django-graphql-social-auth/wiki/Authentication-backends

.. code:: graphql

    mutation SocialAuth($provider: String!, $accessToken: String!) {

      socialAuth(provider: $provider, accessToken: $accessToken) {

        social {

          uid

          extraData

        }

      }

    }

JSON Web Token (JWT)

--------------------

Authentication solution based on `JSON Web Token`_.

.. _JSON Web Token: https://jwt.io/

Install additional requirements.

.. code:: sh

    pip install 'django-graphql-social-auth[jwt]'

Add the ``SocialAuthJWT`` mutation to your GraphQL schema.

.. code:: python

    import graphene

    import graphql_social_auth

    class Mutations(graphene.ObjectType):

        social_auth = graphql_social_auth.SocialAuthJWT.Field()

Authenticate via *accessToken* to obtain a JSON Web Token.

.. code:: graphql

    mutation SocialAuth($provider: String!, $accessToken: String!) {

      socialAuth(provider: $provider, accessToken: $accessToken) {

        social {

          uid

        }

        token

      }

    }

Relay

-----

Complete support for `Relay`_.

.. _Relay: https://facebook.github.io/relay/

.. code:: python

    import graphene

    import graphql_social_auth

    class Mutations(graphene.ObjectType):

        social_auth = graphql_social_auth.relay.SocialAuth.Field()

``graphql_social_auth.relay.SocialAuthJWT.Field()`` for `JSON Web Token (JWT)`_ authentication.

`Relay mutations`_ only accepts one argument named *input*:

.. _Relay mutations: https://facebook.github.io/relay/graphql/mutations.htm

.. code:: graphql

    mutation SocialAuth($provider: String!, $accessToken: String!) {

      socialAuth(input:{provider: $provider, accessToken: $accessToken}) {

        social {

          uid

        }

      }

    }

Customizing

-----------

If you want to customize the ``SocialAuth`` behavior, you'll need to customize the ``resolve()`` method on a subclass of ``SocialAuthMutation`` or ``.relay.SocialAuthMutation.``

.. code:: python

    import graphene

    import graphql_social_auth

    class SocialAuth(graphql_social_auth.SocialAuthMutation):

        user = graphene.Field(UserType)

        @classmethod

        def resolve(cls, root, info, social, **kwargs):

            return cls(user=social.user)

Authenticate via *accessToken* to obtain the *user id*.

.. code:: graphql

    mutation SocialAuth($provider: String!, $accessToken: String!) {

      socialAuth(provider: $provider, accessToken: $accessToken) {

        social {

          uid

        }

        user {

          id

        }

      }

    }

Project template

----------------

There is a `Django project template`_ to start a demo project.

.. _Django project template: https://github.com/ice-creams/graphql-social-auth-template

----

Gracias `@omab`_ / `Python Social Auth`_.

.. _@omab: https://github.com/omab

.. _Python Social Auth: http://python-social-auth.readthedocs.io/

.. |Pypi| image:: https://img.shields.io/pypi/v/django-graphql-social-auth.svg

   :target: https://pypi.python.org/pypi/django-graphql-social-auth

.. |Wheel| image:: https://img.shields.io/pypi/wheel/django-graphql-social-auth.svg

   :target: https://pypi.python.org/pypi/django-graphql-social-auth

.. |Build Status| image:: https://travis-ci.org/flavors/django-graphql-social-auth.svg?branch=master

   :target: https://travis-ci.org/flavors/django-graphql-social-auth

.. |Codecov| image:: https://img.shields.io/codecov/c/github/flavors/django-graphql-social-auth.svg

   :target: https://codecov.io/gh/flavors/django-graphql-social-auth

.. |Code Climate| image:: https://api.codeclimate.com/v1/badges/c579bcfde0fbb7f6334c/maintainability

   :target: https://codeclimate.com/github/flavors/django-graphql-social-auth