Network.OAuth.OAuth2.TokenRequest

Bindings Access Token and Refresh Token part of The OAuth 2.0 Authorization Framework RFC6749 https://www.rfc-editor.org/rfc/rfc6749

Token Request Errors

data TokenResponseError

Constructors

TokenResponseError

Fields

• tokenResponseError :: TokenResponseErrorCode
• tokenResponseErrorDescription :: Maybe Text
• tokenResponseErrorUri :: Maybe (URIRef Absolute)

Instances

FromJSON TokenResponseError

Defined in Network.OAuth.OAuth2.TokenRequest

Methods

parseJSON :: Value -> Parser TokenResponseError

parseJSONList :: Value -> Parser [TokenResponseError]

omittedField :: Maybe TokenResponseError

Show TokenResponseError

Defined in Network.OAuth.OAuth2.TokenRequest

Methods

showsPrec :: Int -> TokenResponseError -> ShowS

show :: TokenResponseError -> String

showList :: [TokenResponseError] -> ShowS

Eq TokenResponseError

Defined in Network.OAuth.OAuth2.TokenRequest

Methods

(==) :: TokenResponseError -> TokenResponseError -> Bool

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

data TokenResponseErrorCode

Token Error Responses https://tools.ietf.org/html/rfc6749#section-5.2

Constructors

InvalidRequest

InvalidClient

InvalidGrant

UnauthorizedClient

UnsupportedGrantType

InvalidScope

UnknownErrorCode Text

Instances

FromJSON TokenResponseErrorCode

Defined in Network.OAuth.OAuth2.TokenRequest

Methods

parseJSON :: Value -> Parser TokenResponseErrorCode

parseJSONList :: Value -> Parser [TokenResponseErrorCode]

omittedField :: Maybe TokenResponseErrorCode

Show TokenResponseErrorCode

Defined in Network.OAuth.OAuth2.TokenRequest

Methods

showsPrec :: Int -> TokenResponseErrorCode -> ShowS

show :: TokenResponseErrorCode -> String

showList :: [TokenResponseErrorCode] -> ShowS

Eq TokenResponseErrorCode

Defined in Network.OAuth.OAuth2.TokenRequest

Methods

(==) :: TokenResponseErrorCode -> TokenResponseErrorCode -> Bool

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

parseTokeResponseError :: ByteString -> TokenResponseError

URL

accessTokenUrl

Arguments

:: OAuth2

-> ExchangeToken

access code gained via authorization URL

-> (URI, PostBody)

access token request URL plus the request body.

Prepare the URL and the request body query for fetching an access token.

refreshAccessTokenUrl

Arguments

:: OAuth2

-> RefreshToken

Refresh Token gained via authorization URL

-> (URI, PostBody)

Refresh Token request URL plus the request body.

Obtain a new access token by sending a Refresh Token to the Authorization server.

Token management

fetchAccessToken

Arguments

:: MonadIO m

=> Manager

HTTP connection manager

-> OAuth2

OAuth Data

-> ExchangeToken

OAuth2 Code

-> ExceptT TokenResponseError m OAuth2Token

Access Token

Exchange code for an Access Token with authenticate in request header.

fetchAccessToken2

Arguments

:: MonadIO m

=> Manager

HTTP connection manager

-> OAuth2

OAuth Data

-> ExchangeToken

Authorization Code

-> ExceptT TokenResponseError m OAuth2Token

Access Token

Deprecated: use fetchAccessTokenWithAuthMethod

fetchAccessTokenInternal

Arguments

:: MonadIO m

=> ClientAuthenticationMethod

-> Manager

HTTP connection manager

-> OAuth2

OAuth Data

-> ExchangeToken

Authorization Code

-> ExceptT TokenResponseError m OAuth2Token

Access Token

Deprecated: use fetchAccessTokenWithAuthMethod

fetchAccessTokenWithAuthMethod

Arguments

:: MonadIO m

=> ClientAuthenticationMethod

-> Manager

HTTP connection manager

-> OAuth2

OAuth Data

-> ExchangeToken

Authorization Code

-> ExceptT TokenResponseError m OAuth2Token

Access Token

Exchange code for an Access Token

OAuth2 spec allows credential (client_id, client_secret) to be sent either in the header (a.k.a ClientSecretBasic). or as form/url params (a.k.a ClientSecretPost).

The OAuth provider can choose to implement only one, or both. Look for API document from the OAuth provider you're dealing with. If you`re uncertain, try fetchAccessToken which sends credential in authorization http header, which is common case.

Since: 2.6.0

refreshAccessToken

Arguments

:: MonadIO m

=> Manager

HTTP connection manager.

-> OAuth2

OAuth context

-> RefreshToken

Refresh Token gained after authorization

-> ExceptT TokenResponseError m OAuth2Token

Fetch a new AccessToken using the Refresh Token with authentication in request header.

refreshAccessToken2

Arguments

:: MonadIO m

=> Manager

HTTP connection manager.

-> OAuth2

OAuth context

-> RefreshToken

Refresh Token gained after authorization

-> ExceptT TokenResponseError m OAuth2Token

Deprecated: use refreshAccessTokenWithAuthMethod

refreshAccessTokenInternal

Arguments

:: MonadIO m

=> ClientAuthenticationMethod

-> Manager

HTTP connection manager.

-> OAuth2

OAuth context

-> RefreshToken

Refresh Token gained after authorization

-> ExceptT TokenResponseError m OAuth2Token

Deprecated: use refreshAccessTokenWithAuthMethod

refreshAccessTokenWithAuthMethod

Arguments

:: MonadIO m

=> ClientAuthenticationMethod

-> Manager

HTTP connection manager.

-> OAuth2

OAuth context

-> RefreshToken

Refresh Token gained after authorization

-> ExceptT TokenResponseError m OAuth2Token

Fetch a new AccessToken using the Refresh Token.

OAuth2 spec allows credential ("client_id", "client_secret") to be sent either in the header (a.k.a ClientSecretBasic). or as form/url params (a.k.a ClientSecretPost).

The OAuth provider can choose to implement only one, or both. Look for API document from the OAuth provider you're dealing with. If you're uncertain, try refreshAccessToken which sends credential in authorization http header, which is common case.

Since: 2.6.0

Utilies

doJSONPostRequest

Arguments

:: (MonadIO m, FromJSON a)

=> Manager

HTTP connection manager.

-> OAuth2

OAuth options

-> URI

The URL

-> PostBody

request body

-> ExceptT TokenResponseError m a

Response as JSON

Conduct post request and return response as JSON.

doSimplePostRequest

Arguments

:: MonadIO m

=> Manager

HTTP connection manager.

-> OAuth2

OAuth options

-> URI

URL

-> PostBody

Request body.

-> ExceptT TokenResponseError m ByteString

Response as ByteString

Conduct post request.

handleOAuth2TokenResponse :: Response ByteString -> Either TokenResponseError ByteString

Gets response body from a Response if 200 otherwise assume TokenResponseError

parseResponseFlexible :: FromJSON a => ByteString -> Either TokenResponseError a

Try to parses response as JSON, if failed, try to parse as like query string.

parseResponseString :: FromJSON a => ByteString -> Either TokenResponseError a

Parses the response that contains not JSON but a Query String

addBasicAuth :: OAuth2 -> Request -> Request

Add Basic Authentication header using client_id and client_secret.

addDefaultRequestHeaders :: Request -> Request

Set several header values: + userAgennt : "hoauth2" + accept : "application/json"

clientSecretPost :: OAuth2 -> PostBody

Add Credential (client_id, client_secret) to the request post body.