Metadata-Version: 2.1
Name: zendesk-django-auth
Version: 0.3.1
Summary: Use your django app as an auth platform for Zendesk.
Home-page: https://github.com/madisona/zendesk_django_auth
Author: Aaron Madison
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
License-File: LICENSE
Requires-Dist: django>=2.2
Requires-Dist: PyJWT<2.5.0,>=2.4.0

Zendesk Django Auth
===================

Allows your Django App to be used as an authentication platform for your Zendesk Account

Zendesk API Documentation
-------------------------
see `http://www.zendesk.com/support/api/remote-authentication` for ZenDesk Documentation.

This module is specifically for Zendesk API v1

Installation
------------
zendesk_auth version 0.0.3+ works with django 1.5 and above

    `pip install zendesk-django-auth`


Usage
-----
Using Zendesk SSO in your app is extremely simple...

in your settings.py, add 'zendesk_auth' to your `INSTALLED_APPS`

Then add the following two settings
    `ZENDESK_URL=https://your_domain.zendesk.com`
    `ZENDESK_TOKEN=you_zendesk_token`

Next, add this (or equivalent) to your urls.py:

    `url(r'', include('zendesk_auth.urls')),`

You'll need to setup your zendesk remote authentication settings to allow/use your zendesk_authorize view.

You're done! Now watch it work.

