Safe Haskell	None
Language	Haskell2010

Web.Apiary.Authenticate

Contents

initializer
handler
filter
action
- getter

Synopsis

Documentation

data Auth Source #

Instances

Extension Auth Source #
Methods extMiddleware :: Auth -> Middleware # extMiddleware' :: Auth -> Middleware' #

data AuthConfig Source #

Constructors

AuthConfig
Fields authSuccessPage :: ByteString authUrl :: Text authPrefix :: [Text] authReturnToPath :: [Text] authLogoutPath :: [Text] providers :: [(Text, Provider)]

Instances

Default AuthConfig Source #
Methods def :: AuthConfig #

data Provider Source #

Constructors

Provider
Fields providerUrl :: Text realm :: Maybe Text parameters :: [(Text, Text)]

data OpenId_ a Source #

Constructors

OpenId_
Fields opLocal :: a params :: [(a, a)] claimed :: Maybe a

Instances

Functor OpenId_ Source #
Methods fmap :: (a -> b) -> OpenId_ a -> OpenId_ b # (<$) :: a -> OpenId_ b -> OpenId_ a #
Eq a => Eq (OpenId_ a) Source #
Methods (==) :: OpenId_ a -> OpenId_ a -> Bool # (/=) :: OpenId_ a -> OpenId_ a -> Bool #
Data a => Data (OpenId_ a) Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OpenId_ a -> c (OpenId_ a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (OpenId_ a) # toConstr :: OpenId_ a -> Constr # dataTypeOf :: OpenId_ a -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c (OpenId_ a)) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (OpenId_ a)) # gmapT :: (forall b. Data b => b -> b) -> OpenId_ a -> OpenId_ a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OpenId_ a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OpenId_ a -> r # gmapQ :: (forall d. Data d => d -> u) -> OpenId_ a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OpenId_ a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OpenId_ a -> m (OpenId_ a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenId_ a -> m (OpenId_ a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OpenId_ a -> m (OpenId_ a) #
Ord a => Ord (OpenId_ a) Source #
Methods compare :: OpenId_ a -> OpenId_ a -> Ordering # (<) :: OpenId_ a -> OpenId_ a -> Bool # (<=) :: OpenId_ a -> OpenId_ a -> Bool # (>) :: OpenId_ a -> OpenId_ a -> Bool # (>=) :: OpenId_ a -> OpenId_ a -> Bool # max :: OpenId_ a -> OpenId_ a -> OpenId_ a # min :: OpenId_ a -> OpenId_ a -> OpenId_ a #
Read a => Read (OpenId_ a) Source #
Methods readsPrec :: Int -> ReadS (OpenId_ a) # readList :: ReadS [OpenId_ a] # readPrec :: ReadPrec (OpenId_ a) # readListPrec :: ReadPrec [OpenId_ a] #
Show a => Show (OpenId_ a) Source #
Methods showsPrec :: Int -> OpenId_ a -> ShowS # show :: OpenId_ a -> String # showList :: [OpenId_ a] -> ShowS #
Serialize (OpenId_ ByteString) Source #
Methods put :: Putter (OpenId_ ByteString) # get :: Get (OpenId_ ByteString) #
Serialize (OpenId_ Text) Source #
Methods put :: Putter (OpenId_ Text) # get :: Get (OpenId_ Text) #

type OpenId = OpenId_ Text Source #

pOpenId :: Proxy OpenId Source #

initializer

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

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

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

handler

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

default auth handlers. since 0.8.0.0.

filter

authorized :: (Has (Session OpenId actM) exts, Monad actM, "auth" </ kvs) => Filter exts actM m kvs (("auth" := OpenId) ': kvs) Source #

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, key </ kvs) => proxy key -> Filter exts actM m kvs ((key := OpenId) ': kvs) Source #

action

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

delete session. since 0.7.0.0.

getter

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

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

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

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