Modulehoauth2-2.15.2Haskell2010

Network.OAuth2.TokenRequest

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

3 types
14 values

Packagehoauth2-2.15.2
Exports17
LanguageHaskell2010
LicenceMIT
SourceTokenRequest.hs

Token Request Errors

3 declarations

datadata TokenResponseError

Constructors

TokenResponseError
- tokenResponseError :: TokenResponseErrorCode
- tokenResponseErrorDescription :: Maybe Text
- tokenResponseErrorUri :: Maybe (URIRef Absolute)

Instances3Eq, Show, FromJSON

Eq TokenResponseErrorDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequest
Show TokenResponseErrorDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequest
FromJSON TokenResponseErrorDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequest

datadata TokenResponseErrorCode

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

Instances3Eq, Show, FromJSON

Eq TokenResponseErrorCodeDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequest
Show TokenResponseErrorCodeDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequest
FromJSON TokenResponseErrorCodeDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequest

valueparseTokeResponseError :: ByteString -> TokenResponseError

Tokens

1 declaration

datadata TokenResponse

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

Constructors

TokenResponse
- 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 by spec, but OAuth2 provider implementations vary. We may remove Maybe in a future release.
- idToken :: Maybe IdToken
  Exists when openid scope is in the Authorization Request and the provider supports OpenID protocol.
- scope :: Maybe Text
- rawResponse :: Object

Instances5Eq, Show, Binary, FromJSON, ToJSON

Eq TokenResponseDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequest
Show TokenResponseDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequest
Binary TokenResponseDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequest
FromJSON TokenResponseDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequest
Parse JSON data into TokenResponse
ToJSON TokenResponseDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequest

URL

2 declarations

valueaccessTokenUrl

:: 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.

valuerefreshAccessTokenUrl

:: 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

4 declarations

valuefetchAccessToken

:: MonadIO m
=> Manager
HTTP connection manager
-> OAuth2
OAuth Data
-> ExchangeToken
OAuth2 Code
-> ExceptT TokenResponseError m TokenResponse
Access Token

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

valuefetchAccessTokenWithAuthMethod

:: MonadIO m
=> ClientAuthenticationMethod
-> Manager
HTTP connection manager
-> OAuth2
OAuth Data
-> ExchangeToken
Authorization Code
-> ExceptT TokenResponseError m TokenResponse
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.

valuerefreshAccessToken

:: MonadIO m
=> Manager
HTTP connection manager.
-> OAuth2
OAuth context
-> RefreshToken
Refresh Token gained after authorization
-> ExceptT TokenResponseError m TokenResponse

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

valuerefreshAccessTokenWithAuthMethod

:: MonadIO m
=> ClientAuthenticationMethod
-> Manager
HTTP connection manager.
-> OAuth2
OAuth context
-> RefreshToken
Refresh Token gained after authorization
-> ExceptT TokenResponseError m TokenResponse

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.

Utilies

7 declarations

valuedoJSONPostRequest

:: (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.

valuedoSimplePostRequest

:: MonadIO m
=> Manager
HTTP connection manager.
-> OAuth2
OAuth options
-> URI
URL
-> PostBody
Request body.
-> ExceptT TokenResponseError m ByteString
Response as ByteString

Conduct post request.

valuehandleOAuth2TokenResponse

:: Response ByteString
-> Either TokenResponseError ByteString

Gets response body from a Response if 200 otherwise assume TokenResponseError

valueparseResponseFlexible

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

valueparseResponseString

Parses the response that contains not JSON but a Query String

valueaddBasicAuth :: OAuth2 -> Request -> Request

Add Basic Authentication header using client_id and client_secret.

valueclientSecretPost :: OAuth2 -> PostBody

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