Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.OAuth.OAuth2.Compat

Contents

Re-exports

Synopsis

data OAuth2 = OAuth2 {
- oauth2ClientId :: Text
- oauth2ClientSecret :: Maybe Text
- oauth2AuthorizeEndpoint :: URIRef Absolute
- oauth2TokenEndpoint :: URIRef Absolute
- oauth2RedirectUri :: Maybe (URIRef Absolute)
}
type OAuth2Result err a = Either err a
type Errors = TokenResponseError
authorizationUrl :: OAuth2 -> URI
fetchAccessToken :: Manager -> OAuth2 -> ExchangeToken -> IO (OAuth2Result Errors OAuth2Token)
fetchAccessToken2 :: Manager -> OAuth2 -> ExchangeToken -> IO (OAuth2Result Errors OAuth2Token)
authGetBS :: Manager -> AccessToken -> URI -> IO (Either ByteString ByteString)
newtype AccessToken = AccessToken {
- atoken :: Text
}
data OAuth2Token = OAuth2Token {
- accessToken :: AccessToken
- refreshToken :: Maybe RefreshToken
- expiresIn :: Maybe Int
- tokenType :: Maybe Text
- idToken :: Maybe IdToken
}
newtype ExchangeToken = ExchangeToken {
- extoken :: Text
}
newtype RefreshToken = RefreshToken {
- rtoken :: Text
}

Documentation

data OAuth2 Source #

Constructors

OAuth2
Fields oauth2ClientId :: Text oauth2ClientSecret :: Maybe Text oauth2AuthorizeEndpoint :: URIRef Absolute oauth2TokenEndpoint :: URIRef Absolute oauth2RedirectUri :: Maybe (URIRef Absolute)

type OAuth2Result err a = Either err a Source #

type Errors = TokenResponseError Source #

authorizationUrl :: OAuth2 -> URI Source #

fetchAccessToken :: Manager -> OAuth2 -> ExchangeToken -> IO (OAuth2Result Errors OAuth2Token) Source #

fetchAccessToken2 :: Manager -> OAuth2 -> ExchangeToken -> IO (OAuth2Result Errors OAuth2Token) Source #

authGetBS :: Manager -> AccessToken -> URI -> IO (Either ByteString ByteString) Source #

Re-exports

newtype AccessToken #

Constructors

AccessToken
Fields atoken :: Text

Instances

Instances details

FromJSON AccessToken
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser AccessToken # parseJSONList :: Value -> Parser [AccessToken] # omittedField :: Maybe AccessToken #
ToJSON AccessToken
Instance details Defined in Network.OAuth.OAuth2.Internal Methods toJSON :: AccessToken -> Value # toEncoding :: AccessToken -> Encoding # toJSONList :: [AccessToken] -> Value # toEncodingList :: [AccessToken] -> Encoding # omitField :: AccessToken -> Bool #
Show AccessToken
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> AccessToken -> ShowS # show :: AccessToken -> String # showList :: [AccessToken] -> ShowS #
Binary AccessToken
Instance details Defined in Network.OAuth.OAuth2.Internal Methods put :: AccessToken -> Put # get :: Get AccessToken # putList :: [AccessToken] -> Put #
Eq AccessToken
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: AccessToken -> AccessToken -> Bool # (/=) :: AccessToken -> AccessToken -> Bool #

data OAuth2Token #

https://www.rfc-editor.org/rfc/rfc6749#section-4.1.4

Constructors

OAuth2Token

Fields

accessToken :: AccessToken
refreshToken :: Maybe RefreshToken
Exists when offline_access scope is in the Authorization Request and the provider supports Refresh Access Token.
expiresIn :: Maybe Int
tokenType :: Maybe Text
See https://www.rfc-editor.org/rfc/rfc6749#section-5.1. It's required per spec. But OAuth2 provider implementation are vary. Maybe will remove Maybe in future release.
idToken :: Maybe IdToken
Exists when openid scope is in the Authorization Request and the provider supports OpenID protocol.

Instances

Instances details

FromJSON OAuth2Token	Parse JSON data into `OAuth2Token`
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser OAuth2Token # parseJSONList :: Value -> Parser [OAuth2Token] # omittedField :: Maybe OAuth2Token #
ToJSON OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal Methods toJSON :: OAuth2Token -> Value # toEncoding :: OAuth2Token -> Encoding # toJSONList :: [OAuth2Token] -> Value # toEncodingList :: [OAuth2Token] -> Encoding # omitField :: OAuth2Token -> Bool #
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 #
Show OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> OAuth2Token -> ShowS # show :: OAuth2Token -> String # showList :: [OAuth2Token] -> ShowS #
Binary OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal Methods put :: OAuth2Token -> Put # get :: Get OAuth2Token # putList :: [OAuth2Token] -> Put #
Eq OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: OAuth2Token -> OAuth2Token -> Bool # (/=) :: OAuth2Token -> OAuth2Token -> Bool #
type Rep OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal type Rep OAuth2Token = D1 ('MetaData "OAuth2Token" "Network.OAuth.OAuth2.Internal" "hoauth2-2.12.0-Elv8q3qryPv2YMNAnWWZ0Q" '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))))))

newtype ExchangeToken #

Authorization Code

Constructors

ExchangeToken
Fields extoken :: Text

Instances

Instances details

FromJSON ExchangeToken
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser ExchangeToken # parseJSONList :: Value -> Parser [ExchangeToken] # omittedField :: Maybe ExchangeToken #
ToJSON ExchangeToken
Instance details Defined in Network.OAuth.OAuth2.Internal Methods toJSON :: ExchangeToken -> Value # toEncoding :: ExchangeToken -> Encoding # toJSONList :: [ExchangeToken] -> Value # toEncodingList :: [ExchangeToken] -> Encoding # omitField :: ExchangeToken -> Bool #
Show ExchangeToken
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> ExchangeToken -> ShowS # show :: ExchangeToken -> String # showList :: [ExchangeToken] -> ShowS #

newtype RefreshToken #

Constructors

RefreshToken
Fields rtoken :: Text

Instances

Instances details

FromJSON RefreshToken
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser RefreshToken # parseJSONList :: Value -> Parser [RefreshToken] # omittedField :: Maybe RefreshToken #
ToJSON RefreshToken
Instance details Defined in Network.OAuth.OAuth2.Internal Methods toJSON :: RefreshToken -> Value # toEncoding :: RefreshToken -> Encoding # toJSONList :: [RefreshToken] -> Value # toEncodingList :: [RefreshToken] -> Encoding # omitField :: RefreshToken -> Bool #
Show RefreshToken
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> RefreshToken -> ShowS # show :: RefreshToken -> String # showList :: [RefreshToken] -> ShowS #
Binary RefreshToken
Instance details Defined in Network.OAuth.OAuth2.Internal Methods put :: RefreshToken -> Put # get :: Get RefreshToken # putList :: [RefreshToken] -> Put #
Eq RefreshToken
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: RefreshToken -> RefreshToken -> Bool # (/=) :: RefreshToken -> RefreshToken -> Bool #