Network.HTTP.Req.OAuth2

This package provides basic support of OAuth2 authentication for Req.

Documentation

newtype AccessToken

OAuth2 access token

Constructors

AccessToken Text

Instances

Show AccessToken

Methods

showsPrec :: Int -> AccessToken -> ShowS

show :: AccessToken -> String

showList :: [AccessToken] -> ShowS

data AccessTokenRequest

Constructors

AccessTokenRequest AuthCode

data AccessTokenResponse

Constructors

AccessTokenResponse TokenPair

data App

A web API application

Constructors

App

Fields

• appAuthUri :: URI
• appTokenUri :: URI
• appUpdateTokenPair :: UpdateTokenPair
• appClientPair :: ClientPair

newtype ClientId

OAuth2 client ID

Constructors

ClientId Text

Instances

Eq ClientId

Methods

(==) :: ClientId -> ClientId -> Bool

(/=) :: ClientId -> ClientId -> Bool

Show ClientId

Methods

showsPrec :: Int -> ClientId -> ShowS

show :: ClientId -> String

showList :: [ClientId] -> ShowS

data ClientPair

OAuth2 client ID/client secret pair

Constructors

ClientPair ClientId ClientSecret

Instances

Eq ClientPair

Methods

(==) :: ClientPair -> ClientPair -> Bool

(/=) :: ClientPair -> ClientPair -> Bool

Show ClientPair

Methods

showsPrec :: Int -> ClientPair -> ShowS

show :: ClientPair -> String

showList :: [ClientPair] -> ShowS

newtype ClientSecret

OAuth2 client secret

Constructors

ClientSecret Text

Instances

Eq ClientSecret

Methods

(==) :: ClientSecret -> ClientSecret -> Bool

(/=) :: ClientSecret -> ClientSecret -> Bool

Show ClientSecret

Methods

showsPrec :: Int -> ClientSecret -> ShowS

show :: ClientSecret -> String

showList :: [ClientSecret] -> ShowS

type OAuth2 = StateT TokenPair IO

OAuth2 application monad

type PromptForCallbackUri = URI -> IO URI

newtype RefreshToken

OAuth2 refresh token

Constructors

RefreshToken Text

Instances

Show RefreshToken

Methods

showsPrec :: Int -> RefreshToken -> ShowS

show :: RefreshToken -> String

showList :: [RefreshToken] -> ShowS

data TokenPair

OAuth2 access/refresh token pair

Constructors

TokenPair AccessToken RefreshToken

Instances

Show TokenPair

Methods

showsPrec :: Int -> TokenPair -> ShowS

show :: TokenPair -> String

showList :: [TokenPair] -> ShowS

type UpdateTokenPair = TokenPair -> IO ()

Action invoked in response to update to access/refresh token pair

evalOAuth2 :: TokenPair -> OAuth2 a -> IO a

fetchAccessToken :: App -> AccessTokenRequest -> IO (Either String AccessTokenResponse)

Gets OAuth2 access token

Implements standard OAuth2 access token workflow for web server apps as described here.

We don't pass client_secret because that would be silly. We also don't bother with redirect_uri since this do not seem to be required.

getAuthCode :: App -> ClientId -> PromptForCallbackUri -> IO AuthCode

Gets OAuth2 authorization code

Implements standard OAuth2 authorization workflow for web server apps as described here.

We don't bother with redirect_uri or state since they do not seem to be required.

oAuth2Get :: (Value -> Parser a) -> Url Https -> App -> OAuth2 a

runOAuth2 :: TokenPair -> OAuth2 a -> IO (a, TokenPair)