Web.Apiary.Authenticate

Documentation

data Auth

Instances

Extension Auth

data AuthConfig

Constructors

AuthConfig

Fields

authSuccessPage :: ByteString

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_

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)

Serialize (OpenId_ ByteString)

Serialize (OpenId_ Text)

Typeable (* -> *) OpenId_

type OpenId = OpenId_ Text

pOpenId :: Proxy OpenId

initializer

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

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

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

handler

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

default auth handlers. since 0.8.0.0.

filter

authorized :: (Has (Session OpenId actM) exts, Monad actM, NotMember "auth" kvs) => ApiaryT exts (("auth" := OpenId) : kvs) actM m () -> ApiaryT exts kvs actM m ()

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

authorized' :: (Has (Session OpenId actM) exts, KnownSymbol key, Monad actM, NotMember key kvs) => proxy key -> ApiaryT exts ((key := OpenId) : kvs) actM m () -> ApiaryT exts kvs actM m ()

action

authLogout :: (Has (Session OpenId m) exts, Monad m) => ActionT exts prms m ()

delete session. since 0.7.0.0.

getter

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

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

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

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