Safe Haskell	None

Yesod.Auth.Zendesk

Synopsis

Documentation

class YesodAuthPersist site => YesodZendesk site whereSource

Type class that you need to implement in order to support Zendesk remote authentication.

Minimal complete definition: all functions are required.

Methods

zendeskToken :: site -> ByteString Source

Shared secret between Zendesk and your site.

zendeskAuthURL :: site -> Text Source

URL on your Zendesk's site where users should be redirected to when logging in.

zendeskUserInfo :: HandlerT site IO ZendeskUser Source

Gather information that should be given to Zendesk about an user. Please see ZendeskUser for more information about what these fields mean.

Simple example:

 zendeskUserInfo = do
   Entity uid user <- requireAuth
   return def { zuName  = userName user
              , zuEmail = userEmail user }

Advanced example:

 zendeskUserInfo = do
   uid <- requireAuthId
   render <- getUrlRender
   runDB $ do
     Just user <- get uid
     Just org  <- get (userOrganization user)
     return def { zuName           = userName user
                , zuEmail          = userEmail user
                , zuOrganization   = Just (organizationName org)
                , zuRemotePhotoURL = Just (render $ UserPhotoR uid)
                }

Note: although I don't recomend this and I don't see any reason why you would do it, it is possible to use maybeAuth instead of requireAuth and login on Zendesk with some sort of guest user should the user not be logged in.

data ZendeskUser Source

Information about a user that is given to Zendesk. Please see Zendesk's documentation (http://www.zendesk.com/support/api/remote-authentication) in order to see more details of how theses fields are interpreted.

Only zuName and zuEmail are required.

Constructors

ZendeskUser
Fields zuName :: Text User name, at least two characters. (required) zuEmail :: Text E-mail address. (required) zuExternalId :: ZendeskExternalId An external (to Zendesk) ID that identifies this user. Defaults to `UseYesodAuthId`. zuOrganization :: Maybe Text Organization the user belongs to. zuTags :: [Text] List of tags. zuRemotePhotoURL :: Maybe Text Public URL with the user's profile picture.

Instances

Eq ZendeskUser
Ord ZendeskUser
Read ZendeskUser
Show ZendeskUser
Default ZendeskUser	Fields `zuName` and `zuEmail` are required, so `def` will be `undefined` for them.

data ZendeskExternalId Source

Which external ID should be given to Zendesk.

Constructors

UseYesodAuthId	Use the user ID from `persistent`'s database. This is the recommended and default value.
Explicit Text	Use this given value.
NoExternalId	Do not give an external ID.

Instances

Eq ZendeskExternalId
Ord ZendeskExternalId
Read ZendeskExternalId
Show ZendeskExternalId
Default ZendeskExternalId	Default is `UseYesodAuthId`.

data Zendesk Source

Data type for yesod-auth-zendesk's subsite.

Instances

RouteAttrs Zendesk
ParseRoute Zendesk
RenderRoute Zendesk
YesodZendesk site => YesodSubDispatch Zendesk (HandlerT site IO)
Eq (Route Zendesk)
Read (Route Zendesk)
Show (Route Zendesk)

getZendesk :: a -> Zendesk Source

Create a new Zendesk, use this on your config/routes file.

zendeskLoginRoute :: Route Zendesk Source

Redirect the user to Zendesk such that they're already logged in when they arrive. For example, you may use zendeskLoginRoute when the user clicks on a "Support" item on a menu.