GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02
Modulehoauth2-2.15.2Haskell2010
Bindings Access Token and Refresh Token part of The OAuth 2.0 Authorization Framework RFC6749 https://www.rfc-editor.org/rfc/rfc6749
Eq TokenResponseErrorDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequestShow TokenResponseErrorDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequestFromJSON TokenResponseErrorDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequestToken Error Responses https://tools.ietf.org/html/rfc6749#section-5.2
Eq TokenResponseErrorCodeDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequestShow TokenResponseErrorCodeDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequestFromJSON TokenResponseErrorCodeDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequestTokenResponseaccessToken :: AccessTokenrefreshToken :: Maybe RefreshTokenExists when offline_access scope is in the Authorization Request and the provider supports Refresh Access Token.
expiresIn :: Maybe InttokenType :: Maybe TextSee 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 IdTokenExists when openid scope is in the Authorization Request and the provider supports OpenID protocol.
scope :: Maybe TextrawResponse :: ObjectEq TokenResponseDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequestShow TokenResponseDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequestBinary TokenResponseDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequestFromJSON TokenResponseDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequestParse JSON data into TokenResponse
ToJSON TokenResponseDefined in hoauth2-2.15.2 · Network.OAuth2.TokenRequestaccessTokenUrl :: OAuth2-> ExchangeTokenaccess 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 :: OAuth2-> RefreshTokenRefresh 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.
fetchAccessToken :: MonadIO m=> ManagerHTTP connection manager
-> OAuth2OAuth Data
-> ExchangeTokenOAuth2 Code
-> ExceptT TokenResponseError m TokenResponseAccess Token
Exchange code for an Access Token with authenticate in request header.
fetchAccessTokenWithAuthMethod :: MonadIO m=> ClientAuthenticationMethod-> ManagerHTTP connection manager
-> OAuth2OAuth Data
-> ExchangeTokenAuthorization Code
-> ExceptT TokenResponseError m TokenResponseAccess 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.
refreshAccessToken :: MonadIO m=> ManagerHTTP connection manager.
-> OAuth2OAuth context
-> RefreshTokenRefresh Token gained after authorization
-> ExceptT TokenResponseError m TokenResponseFetch a new AccessToken using the Refresh Token with authentication in request header.
refreshAccessTokenWithAuthMethod :: MonadIO m=> ClientAuthenticationMethod-> ManagerHTTP connection manager.
-> OAuth2OAuth context
-> RefreshTokenRefresh Token gained after authorization
-> ExceptT TokenResponseError m TokenResponseFetch 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.
doJSONPostRequest Conduct post request and return response as JSON.
doSimplePostRequest :: MonadIO m=> ManagerHTTP connection manager.
-> OAuth2OAuth options
-> URIURL
-> PostBodyRequest body.
-> ExceptT TokenResponseError m ByteStringResponse as ByteString
Conduct post request.
Gets response body from a Response if 200 otherwise assume TokenResponseError
Try to parses response as JSON, if failed, try to parse as like query string.
Parses the response that contains not JSON but a Query String
Add Basic Authentication header using client_id and client_secret.
Add Credential (client_id, client_secret) to the request post body.