Yesod.Auth.OAuth2

Generic OAuth2 plugin for Yesod

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

Documentation

authOAuth2

Arguments

:: YesodAuth m

=> Text

Service name

-> OAuth2

Service details

-> (Manager -> OAuth2Token -> IO (Creds m))

This function defines how to take an OAuth2Token and retrieve additional information about the user, to be set in the session as Creds. Usually this means a second authorized request to api/me.json.

See fromProfileURL for an example.

-> AuthPlugin m

Create an AuthPlugin for the given OAuth2 provider

Presents a generic "Login via name" link

authOAuth2Widget :: YesodAuth m => WidgetT m IO () -> Text -> OAuth2 -> (Manager -> OAuth2Token -> IO (Creds m)) -> AuthPlugin m

Create an AuthPlugin for the given OAuth2 provider

Allows passing a custom widget for the login link. See oauth2Eve for an example.

oauth2Url :: Text -> AuthRoute

fromProfileURL

Arguments

:: FromJSON a

=> Text

Plugin name

-> URI

Profile URI

-> (a -> Creds m)

Conversion to Creds

-> Manager

-> OAuth2Token

-> IO (Creds m)

Handle the common case of fetching Profile information from a JSON endpoint

Throws InvalidProfileResponse if JSON parsing fails

data YesodOAuth2Exception

Provider name and Aeson parse error

Constructors

InvalidProfileResponse Text ByteString

Instances

Show YesodOAuth2Exception

Methods

showsPrec :: Int -> YesodOAuth2Exception -> ShowS

show :: YesodOAuth2Exception -> String

showList :: [YesodOAuth2Exception] -> ShowS

Exception YesodOAuth2Exception

Methods

toException :: YesodOAuth2Exception -> SomeException

fromException :: SomeException -> Maybe YesodOAuth2Exception

displayException :: YesodOAuth2Exception -> String

invalidProfileResponse :: Text -> OAuth2Error Value -> YesodOAuth2Exception

Construct an InvalidProfileResponse exception from an OAuth2Error

This forces the e in OAuth2Error e to parse as a JSON Value which is then re-encoded for the exception message.

scopeParam :: Text -> [Text] -> (ByteString, ByteString)

A tuple of scope and the given scopes separated by a delimiter

maybeExtra :: Text -> Maybe Text -> [(Text, Text)]

A helper for providing an optional value to credsExtra

module Network.OAuth.OAuth2

module URI.ByteString

module URI.ByteString.Extension