Network.Wai.Middleware.Auth.OAuth2

Documentation

data OAuth2

General OAuth2 authentication Provider.

Constructors

OAuth2

Fields

• oa2ClientId :: Text
• oa2ClientSecret :: Text
• oa2AuthorizeEndpoint :: Text
• oa2AccessTokenEndpoint :: Text
• oa2Scope :: Maybe [Text]
• oa2ProviderInfo :: ProviderInfo

Instances

ToJSON OAuth2

Defined in Network.Wai.Middleware.Auth.OAuth2

Methods

toJSON :: OAuth2 -> Value

toEncoding :: OAuth2 -> Encoding

toJSONList :: [OAuth2] -> Value

toEncodingList :: [OAuth2] -> Encoding

FromJSON OAuth2

Defined in Network.Wai.Middleware.Auth.OAuth2

Methods

parseJSON :: Value -> Parser OAuth2

parseJSONList :: Value -> Parser [OAuth2]

AuthProvider OAuth2

Defined in Network.Wai.Middleware.Auth.OAuth2

Methods

getProviderName :: OAuth2 -> Text

getProviderInfo :: OAuth2 -> ProviderInfo

handleLogin :: OAuth2 -> Request -> [Text] -> Render ProviderUrl -> (AuthLoginState -> IO Response) -> (Status -> ByteString -> IO Response) -> IO Response

refreshLoginState :: OAuth2 -> Request -> AuthUser -> IO (Maybe (Request, AuthUser))

oAuth2Parser :: ProviderParser

Aeson parser for OAuth2 provider.

Since: 0.1.0

data URIParseException

Used for validating proper url structure. Can be thrown by parseAbsoluteURI and consequently by handleLogin for OAuth2 Provider instance.

Since: 0.1.2.0

Constructors

URIParseException URIParseError

Instances

Show URIParseException

Defined in Network.Wai.Middleware.Auth.OAuth2

Methods

showsPrec :: Int -> URIParseException -> ShowS

show :: URIParseException -> String

showList :: [URIParseException] -> ShowS

Exception URIParseException

Defined in Network.Wai.Middleware.Auth.OAuth2

Methods

toException :: URIParseException -> SomeException

fromException :: SomeException -> Maybe URIParseException

displayException :: URIParseException -> String

parseAbsoluteURI :: MonadThrow m => Text -> m URI

Parse absolute URI and throw URIParseException in case it is malformed

Since: 0.1.2.0

getAccessToken :: Request -> Maybe OAuth2Token

Get the AccessToken for the current user.

If called on a Request behind the middleware, should always return a Just value.

Since: 0.2.0.0