Freshdesk simple SSO support for Authentic2
Project description
Authentic2 Freshdesk login
==========================
This plugin allows Authentic2 IDP to log your users to freshdesk through
freshdesk simple SSO mechanism.
Install
-------
You just have to install the package in your virtualenv and relaunch, it will
be automatically loaded by authentic2.
### Freshdesk configuration
- Go to https://yourcompany.freshdesk.com/admin/security
- enable *SSO simple*
- In *Remote login URL* put something like
`https://myidp.example.com/idp/freshdesk/login/`
- In *Remote logout URL* put something like
`https://myidp.example.com/idp/logout/`
- Note down the shared secret
### Authentic configuration
Set in your *local_settings.py* the following settings according to your
fresdhesk site.
FRESHDESK_URL = 'http://yourcompany.freshdesk.com'
FRESHDESK_SECRET_KEY = 'XXXXXXXXXXXX'
### Diverting some users to somewhere else
You may need to authorize freshdesk access only for a subset of your users,
willing to redirect others to a custom URL (ex: custom error page). There is the
`FRESHDESK_DIVERT` setting for that.
you should point it to an object instance with two methods :
should_divert(email) and divert_url(email), for ex:
class TestDiverter():
def should_divert(self, user):
"""
:returns True if the user should be diverted out of FD false else
if user.email == 'foobar@example.com':
return True
else:
return False
def divert_url(self, user, request):
"""
:returns an url, the diversion path, the system will HTTP 302 there.
"""
return 'http://example.com/{}'.format(user.email)
And in your `local_settings.py`
FRESHDESK_DIVERT='mymodule.TestDiverter'
==========================
This plugin allows Authentic2 IDP to log your users to freshdesk through
freshdesk simple SSO mechanism.
Install
-------
You just have to install the package in your virtualenv and relaunch, it will
be automatically loaded by authentic2.
### Freshdesk configuration
- Go to https://yourcompany.freshdesk.com/admin/security
- enable *SSO simple*
- In *Remote login URL* put something like
`https://myidp.example.com/idp/freshdesk/login/`
- In *Remote logout URL* put something like
`https://myidp.example.com/idp/logout/`
- Note down the shared secret
### Authentic configuration
Set in your *local_settings.py* the following settings according to your
fresdhesk site.
FRESHDESK_URL = 'http://yourcompany.freshdesk.com'
FRESHDESK_SECRET_KEY = 'XXXXXXXXXXXX'
### Diverting some users to somewhere else
You may need to authorize freshdesk access only for a subset of your users,
willing to redirect others to a custom URL (ex: custom error page). There is the
`FRESHDESK_DIVERT` setting for that.
you should point it to an object instance with two methods :
should_divert(email) and divert_url(email), for ex:
class TestDiverter():
def should_divert(self, user):
"""
:returns True if the user should be diverted out of FD false else
if user.email == 'foobar@example.com':
return True
else:
return False
def divert_url(self, user, request):
"""
:returns an url, the diversion path, the system will HTTP 302 there.
"""
return 'http://example.com/{}'.format(user.email)
And in your `local_settings.py`
FRESHDESK_DIVERT='mymodule.TestDiverter'
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for authentic2-idp-freshdesk-0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf6fc1c61a3f4aa71e0edc356d5dc6c661d13df5b3ae0840f046ccce12e99be9 |
|
MD5 | 0f4457454dee16e749840fd76d0fffde |
|
BLAKE2b-256 | 4b74d89ba26edc0ed88bb017d33954c6bfa00342520227741c90e1a8a4b2b3e4 |