Web.Apiary.Authenticate

Documentation

data Auth

data AuthConfig

Constructors

AuthConfig

Fields

authSessionName :: ByteString

authSuccessPage :: ByteString

authSessionConfig :: SessionConfig

authUrl :: Text

authPrefix :: [Text]

authReturnToPath :: [Text]

authLogoutPath :: [Text]

providers :: [(Text, Provider)]

Instances

Default AuthConfig

data Provider

Constructors

Provider

Fields

providerUrl :: Text

realm :: Maybe Text

parameters :: [(Text, Text)]

data OpenId_ a

Constructors

OpenId_

Fields

opLocal :: a

params :: [(a, a)]

claimed :: Maybe a

Instances

Functor OpenId_

Typeable1 OpenId_

Eq a => Eq (OpenId_ a)

Data a => Data (OpenId_ a)

Ord a => Ord (OpenId_ a)

Read a => Read (OpenId_ a)

Show a => Show (OpenId_ a)

Generic (OpenId_ a)

Query (OpenId_ Text)

Binary (OpenId_ ByteString)

Binary (OpenId_ Text)

type OpenId = OpenId_ Text

initializer

initAuth :: (Has Session exts, MonadBaseControl IO m) => AuthConfig -> Initializer exts m (Auth : exts)

initAuthWith :: (Has Session exts, MonadBaseControl IO m) => ManagerSettings -> AuthConfig -> Initializer exts m (Auth : exts)

initAuthWithManager :: (Has Session exts, MonadBaseControl IO m) => Manager -> AuthConfig -> Initializer exts m (Auth : exts)

handler

authHandler :: (Monad m, MonadIO actM, Has Auth exts, Has Session exts) => ApiaryT exts prms actM m ()

default auth handlers. since 0.8.0.0.

filter

authorized :: (Has Auth exts, MonadIO actM, Has Session exts) => ApiaryT exts (OpenId : prms) actM m () -> ApiaryT exts prms actM m ()

filter which check whether logged in or not, and get id. since 0.7.0.0.

action

authLogout :: (Monad m, Has Auth exts) => ActionT exts m ()

delete session. since 0.7.0.0.

getter

authConfig :: (Has Auth exts, Monad m) => ActionT exts m AuthConfig

authProviders :: (Has Auth exts, Monad m) => ActionT exts m [(Text, Provider)]

authRoutes :: (Has Auth exts, Monad m) => ActionT exts m [(Text, ByteString)]

get authenticate routes: (title, route). since 0.7.0.0.