Safe Haskell	None
Language	Haskell2010

Yesod.Auth.OAuth2

Contents

Description

Generic OAuth2 plugin for Yesod

See Yesod.Auth.OAuth2.GitHub for example usage.

Synopsis

data OAuth2 = OAuth2 {
- oauthClientId :: Text
- oauthClientSecret :: Maybe Text
- oauthOAuthorizeEndpoint :: URI
- oauthAccessTokenEndpoint :: URI
- oauthCallback :: Maybe URI
}
type FetchCreds m = Manager -> OAuth2Token -> IO (Creds m)
data Manager
data OAuth2Token = OAuth2Token {
- accessToken :: AccessToken
- refreshToken :: Maybe RefreshToken
- expiresIn :: Maybe Int
- tokenType :: Maybe Text
- idToken :: Maybe IdToken
}
data Creds master = Creds {
- credsPlugin :: Text
- credsIdent :: Text
- credsExtra :: [(Text, Text)]
}
oauth2Url :: Text -> AuthRoute
authOAuth2 :: YesodAuth m => Text -> OAuth2 -> FetchCreds m -> AuthPlugin m
authOAuth2Widget :: YesodAuth m => WidgetFor m () -> Text -> OAuth2 -> FetchCreds m -> AuthPlugin m
authOAuth2' :: YesodAuth m => Text -> OAuth2 -> FetchCreds m -> AuthPlugin m
authOAuth2Widget' :: YesodAuth m => WidgetFor m () -> Text -> OAuth2 -> FetchCreds m -> AuthPlugin m
getAccessToken :: Creds m -> Maybe AccessToken
getRefreshToken :: Creds m -> Maybe RefreshToken
getUserResponse :: Creds m -> Maybe ByteString
getUserResponseJSON :: FromJSON a => Creds m -> Either String a

Documentation

data OAuth2 #

Query Parameter Representation

Constructors

OAuth2
Fields oauthClientId :: Text oauthClientSecret :: Maybe Text oauthOAuthorizeEndpoint :: URI oauthAccessTokenEndpoint :: URI oauthCallback :: Maybe URI

Instances

Instances details

Eq OAuth2
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: OAuth2 -> OAuth2 -> Bool # (/=) :: OAuth2 -> OAuth2 -> Bool #
Show OAuth2
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> OAuth2 -> ShowS # show :: OAuth2 -> String # showList :: [OAuth2] -> ShowS #

type FetchCreds m = Manager -> OAuth2Token -> IO (Creds m) Source #

How to take an OAuth2Token and retrieve user credentials

data Manager #

Keeps track of open connections for keep-alive.

If possible, you should share a single Manager between multiple threads and requests.

Since 0.1.0

Instances

Instances details

HasHttpManager Manager
Instance details Defined in Network.HTTP.Client.Types Methods getHttpManager :: Manager -> Manager #

data OAuth2Token #

The gained Access Token. Use Data.Aeson.decode to decode string to AccessToken. The refreshToken is special in some cases, e.g. https://developers.google.com/accounts/docs/OAuth2

Constructors

OAuth2Token
Fields accessToken :: AccessToken refreshToken :: Maybe RefreshToken expiresIn :: Maybe Int tokenType :: Maybe Text idToken :: Maybe IdToken

Instances

Instances details

Eq OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: OAuth2Token -> OAuth2Token -> Bool # (/=) :: OAuth2Token -> OAuth2Token -> Bool #
Show OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> OAuth2Token -> ShowS # show :: OAuth2Token -> String # showList :: [OAuth2Token] -> ShowS #
Generic OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal Associated Types type Rep OAuth2Token :: Type -> Type # Methods from :: OAuth2Token -> Rep OAuth2Token x # to :: Rep OAuth2Token x -> OAuth2Token #
ToJSON OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal Methods toJSON :: OAuth2Token -> Value # toEncoding :: OAuth2Token -> Encoding # toJSONList :: [OAuth2Token] -> Value # toEncodingList :: [OAuth2Token] -> Encoding #
FromJSON OAuth2Token	Parse JSON data into `OAuth2Token`
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser OAuth2Token # parseJSONList :: Value -> Parser [OAuth2Token] #
Binary OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal Methods put :: OAuth2Token -> Put # get :: Get OAuth2Token # putList :: [OAuth2Token] -> Put #
type Rep OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal type Rep OAuth2Token = D1 ('MetaData "OAuth2Token" "Network.OAuth.OAuth2.Internal" "hoauth2-1.14.0-DQ8D4WFJzqL3u7puVbWEzM" 'False) (C1 ('MetaCons "OAuth2Token" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AccessToken) :: S1 ('MetaSel ('Just "refreshToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe RefreshToken))) :: (S1 ('MetaSel ('Just "expiresIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "tokenType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "idToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe IdToken))))))

data Creds master #

User credentials

Constructors

Creds
Fields credsPlugin :: Text How the user was authenticated credsIdent :: Text Identifier. Exact meaning depends on plugin. credsExtra :: [(Text, Text)]

Instances

Instances details

Show (Creds master)
Instance details Defined in Yesod.Auth Methods showsPrec :: Int -> Creds master -> ShowS # show :: Creds master -> String # showList :: [Creds master] -> ShowS #