Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.OAuth.OAuth2.HttpClient

Contents

AUTH requests
Types

Description

Bindings for The OAuth 2.0 Authorization Framework: Bearer Token Usage RFC6750 https://www.rfc-editor.org/rfc/rfc6750

Synopsis

authGetJSON :: (MonadIO m, FromJSON a) => Manager -> AccessToken -> URI -> ExceptT ByteString m a
authGetBS :: MonadIO m => Manager -> AccessToken -> URI -> ExceptT ByteString m ByteString
authGetBS2 :: MonadIO m => Manager -> AccessToken -> URI -> ExceptT ByteString m ByteString
authGetJSONWithAuthMethod :: (MonadIO m, FromJSON a) => APIAuthenticationMethod -> Manager -> AccessToken -> URI -> ExceptT ByteString m a
authGetJSONInternal :: (MonadIO m, FromJSON a) => APIAuthenticationMethod -> Manager -> AccessToken -> URI -> ExceptT ByteString m a
authGetBSWithAuthMethod :: MonadIO m => APIAuthenticationMethod -> Manager -> AccessToken -> URI -> ExceptT ByteString m ByteString
authGetBSInternal :: MonadIO m => APIAuthenticationMethod -> Manager -> AccessToken -> URI -> ExceptT ByteString m ByteString
authPostJSON :: (MonadIO m, FromJSON a) => Manager -> AccessToken -> URI -> PostBody -> ExceptT ByteString m a
authPostBS :: MonadIO m => Manager -> AccessToken -> URI -> PostBody -> ExceptT ByteString m ByteString
authPostBS2 :: MonadIO m => Manager -> AccessToken -> URI -> PostBody -> ExceptT ByteString m ByteString
authPostBS3 :: MonadIO m => Manager -> AccessToken -> URI -> PostBody -> ExceptT ByteString m ByteString
authPostJSONWithAuthMethod :: (MonadIO m, FromJSON a) => APIAuthenticationMethod -> Manager -> AccessToken -> URI -> PostBody -> ExceptT ByteString m a
authPostJSONInternal :: (MonadIO m, FromJSON a) => APIAuthenticationMethod -> Manager -> AccessToken -> URI -> PostBody -> ExceptT ByteString m a
authPostBSWithAuthMethod :: MonadIO m => APIAuthenticationMethod -> Manager -> AccessToken -> URI -> PostBody -> ExceptT ByteString m ByteString
authPostBSInternal :: MonadIO m => APIAuthenticationMethod -> Manager -> AccessToken -> URI -> PostBody -> ExceptT ByteString m ByteString
data APIAuthenticationMethod

AUTH requests

authGetJSON Source #

Arguments

:: (MonadIO m, FromJSON a)
=> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> ExceptT ByteString m a	Response as JSON

Conduct an authorized GET request and return response as JSON. Inject Access Token to Authorization Header.

authGetBS Source #

Arguments

:: MonadIO m
=> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> ExceptT ByteString m ByteString	Response as ByteString

Conduct an authorized GET request. Inject Access Token to Authorization Header.

authGetBS2 Source #

Arguments

:: MonadIO m
=> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> ExceptT ByteString m ByteString	Response as ByteString

Deprecated: use authGetBSWithAuthMethod

Same to authGetBS but set access token to query parameter rather than header

authGetJSONWithAuthMethod Source #

Arguments

:: (MonadIO m, FromJSON a)
=> APIAuthenticationMethod
-> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> ExceptT ByteString m a	Response as JSON

Conduct an authorized GET request and return response as JSON. Allow to specify how to append AccessToken.

Since: 2.6.0

authGetJSONInternal Source #

Arguments

:: (MonadIO m, FromJSON a)
=> APIAuthenticationMethod
-> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> ExceptT ByteString m a	Response as JSON

Deprecated: use authGetJSONWithAuthMethod

Deprecated. Use authGetJSONWithAuthMethod instead.

authGetBSWithAuthMethod Source #

Arguments

:: MonadIO m
=> APIAuthenticationMethod	Specify the way that how to append the `AccessToken` in the request
-> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> ExceptT ByteString m ByteString	Response as ByteString

Conduct an authorized GET request and return response as ByteString. Allow to specify how to append AccessToken.

Since: 2.6.0

authGetBSInternal Source #

Arguments

:: MonadIO m
=> APIAuthenticationMethod
-> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> ExceptT ByteString m ByteString	Response as ByteString

Deprecated: use authGetBSWithAuthMethod

authPostJSON Source #

Arguments

:: (MonadIO m, FromJSON a)
=> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> PostBody
-> ExceptT ByteString m a	Response as JSON

Conduct POST request and return response as JSON. Inject Access Token to Authorization Header.

authPostBS Source #

Arguments

:: MonadIO m
=> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> PostBody
-> ExceptT ByteString m ByteString	Response as ByteString

Conduct POST request. Inject Access Token to http header (Authorization)

authPostBS2 Source #

Arguments

:: MonadIO m
=> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> PostBody
-> ExceptT ByteString m ByteString	Response as ByteString

Deprecated: use authPostBSWithAuthMethod

Conduct POST request with access token only in the request body but header.

authPostBS3 Source #

Arguments

:: MonadIO m
=> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> PostBody
-> ExceptT ByteString m ByteString	Response as ByteString

Deprecated: use authPostBSWithAuthMethod

Conduct POST request with access token only in the header and not in body

authPostJSONWithAuthMethod Source #

Arguments

:: (MonadIO m, FromJSON a)
=> APIAuthenticationMethod
-> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> PostBody
-> ExceptT ByteString m a	Response as ByteString

Conduct POST request and return response as JSON. Allow to specify how to append AccessToken.

Since: 2.6.0

authPostJSONInternal Source #

Arguments

:: (MonadIO m, FromJSON a)
=> APIAuthenticationMethod
-> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> PostBody
-> ExceptT ByteString m a	Response as ByteString

Deprecated: use authPostJSONWithAuthMethod

authPostBSWithAuthMethod Source #

Arguments

:: MonadIO m
=> APIAuthenticationMethod
-> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> PostBody
-> ExceptT ByteString m ByteString	Response as ByteString

Conduct POST request and return response as ByteString. Allow to specify how to append AccessToken.

Since: 2.6.0

authPostBSInternal Source #

Arguments

:: MonadIO m
=> APIAuthenticationMethod
-> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> PostBody
-> ExceptT ByteString m ByteString	Response as ByteString

Deprecated: use authPostBSWithAuthMethod

Types

data APIAuthenticationMethod Source #

https://www.rfc-editor.org/rfc/rfc6750#section-2

Constructors

AuthInRequestHeader	Provides in Authorization header
AuthInRequestBody	Provides in request body
AuthInRequestQuery	Provides in request query parameter

Instances

Instances details

Eq APIAuthenticationMethod Source #
Instance details Defined in Network.OAuth.OAuth2.HttpClient Methods (==) :: APIAuthenticationMethod -> APIAuthenticationMethod -> Bool # (/=) :: APIAuthenticationMethod -> APIAuthenticationMethod -> Bool #
Ord APIAuthenticationMethod Source #
Instance details Defined in Network.OAuth.OAuth2.HttpClient Methods compare :: APIAuthenticationMethod -> APIAuthenticationMethod -> Ordering # (<) :: APIAuthenticationMethod -> APIAuthenticationMethod -> Bool # (<=) :: APIAuthenticationMethod -> APIAuthenticationMethod -> Bool # (>) :: APIAuthenticationMethod -> APIAuthenticationMethod -> Bool # (>=) :: APIAuthenticationMethod -> APIAuthenticationMethod -> Bool # max :: APIAuthenticationMethod -> APIAuthenticationMethod -> APIAuthenticationMethod # min :: APIAuthenticationMethod -> APIAuthenticationMethod -> APIAuthenticationMethod #