Place the authentication information in a URL encoded body instead of the Authorization header.
Note that the first parameter is used for realm in addAuthHeader, and this function needs the same type. The parameter, however, is unused.
Since 1.5.1
:: a typeCtrl KGHC 9.14.1 · lts/ghc-9.14.x · 3e2d568 · 2026-10-11
Moduleauthenticate-oauth-1.7Haskell2010
Deprecated. This module is deprecated; rewrite your code using MonadResource
This Module provides interface for the instance of MonadIO instead of MonadIO.
What this module do is just adding withManager or runResourceT.
Place the authentication information in a URL encoded body instead of the Authorization header.
Note that the first parameter is used for realm in addAuthHeader, and this function needs the same type. The parameter, however, is unused.
Since 1.5.1
authorizeUrl :: OAuthOAuth Application
-> CredentialTemporary Credential (Request Token & Secret)
-> StringURL to authorize
URL to obtain OAuth verifier.
authorizeUrl' :: (OAuth -> Credential -> SimpleQuery)-> OAuthOAuth Application
-> CredentialTemporary Credential (Request Token & Secret)
-> StringURL to authorize
Convert OAuth and Credential to URL to authorize. This takes function to choice parameter to pass to the server other than oauth_callback or oauth_token.
Test existing OAuth signature. Since 1.5.2
Create a value of type AccessTokenRequest with default values filled in.
Note that this is a settings type. More information on usage can be found at: http://www.yesodweb.com/book/settings-types.
Since 1.5.1
Remove an oauth parameter for key from given Credential.
Empty credential.
Generate OAuth signature. Used by signOAuth.
getAccessTokenWith :: MonadIO m=> AccessTokenRequestextensible parameters
-> m (Either (Response ByteString) Credential)Token Credential (Access Token & Secret) or the conduit response on failures
Insert oauth-verifier on a Credential.
Insert an oauth parameter into given Credential.
Convenient method for inserting multiple parameters into credential.
newCredential :: ByteStringvalue for oauth_token
-> ByteStringvalue for oauth_token_secret
-> CredentialConvenient function to create Credential with OAuth Token and Token Secret.
Default value for OAuth datatype. You must specify at least oauthServerName, URIs and Tokens.
Encode a string using the percent encoding method for OAuth.
signOAuth :: MonadIO m=> OAuthOAuth Application
-> CredentialCredential
-> RequestOriginal Request
-> m RequestSigned OAuth Request
Add OAuth headers & sign to Request.
Data type for getAccessTokenWith method.
You can create values of this type using defaultAccessTokenRequest.
Since 1.5.1
add auth hook.
Default: addAuthHeader
Since 1.5.1
Manager
Since 1.5.1
OAuth Application
Since 1.5.1
Request Hook.
Default: id
Since 1.5.1
Temporary Credential (with oauth_verifier if >= 1.0a)
Since 1.5.1
Data type for credential.
Eq CredentialDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthData CredentialDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthOrd CredentialDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthRead CredentialDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthShow CredentialDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthData type for OAuth client (consumer).
The constructor for this data type is not exposed. Instead, you should use the def method or newOAuth function to retrieve a default instance, and then use the records below to make modifications. This approach allows us to add configuration options without breaking backwards compatibility.
Eq OAuthDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthData OAuthDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthRead OAuthDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthShow OAuthDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthDefault OAuthDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthUri to obtain access token (default: "").
You MUST specify if you use getAcessToken or getAccessToken' or getAccessTokenWith;
otherwise you can just leave this empty.
Uri to authorize (default: "").
You MUST specify if you use authorizeUrl or authorizeZUrl';
otherwise you can just leave this empty.
Callback uri to redirect after authentication (default: Nothing)
Consumer key (You MUST specify)
Consumer Secret (You MUST specify)
Optional authorization realm (default: Nothing)
URI to request temporary credential (default: "").
You MUST specify if you use getTemporaryCredential', getTemporaryCredentialProxy
or getTemporaryCredential; otherwise you can just leave this empty.
Service name (default: "")
Signature Method (default: HMACSHA1)
OAuth spec version (default: OAuth10a)
Eq OAuthExceptionDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthData OAuthExceptionDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthShow OAuthExceptionDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthException OAuthExceptionDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthEnum OAuthVersionDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthEq OAuthVersionDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthData OAuthVersionDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthOrd OAuthVersionDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthRead OAuthVersionDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthShow OAuthVersionDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthData type for signature method.
Eq SignMethodDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthData SignMethodDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthRead SignMethodDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthShow SignMethodDefined in authenticate-oauth-1.7 · Web.Authenticate.OAuthThe default value for this type.
getAccessToken :: MonadIO m=> OAuthOAuth Application
-> CredentialTemporary Credential with oauth_verifier
-> m CredentialToken Credential (Access Token & Secret)
Get Access token.
getTemporaryCredential :: MonadIO m=> OAuthOAuth Application
-> m CredentialTemporary Credential (Request Token & Secret).
Get temporary credential for requesting acces token.
getTemporaryCredentialWithScope :: MonadIO m=> ByteStringScope parameter string
-> OAuthOAuth Application
-> m CredentialTemporay Credential (Request Token & Secret).
Get temporary credential for requesting access token with Scope parameter.
getTemporaryCredentialProxy :: MonadIO m=> Maybe ProxyProxy
-> OAuthOAuth Application
-> m CredentialTemporary Credential (Request Token & Secret).
Get temporary credential for requesting access token via the proxy.
getTemporaryCredential' :: MonadIO m=> (Request -> Request)Request Hook
-> OAuthOAuth Application
-> m CredentialTemporary Credential (Request Token & Secret).
getTokenCredential :: MonadIO m=> OAuthOAuth Application
-> CredentialTemporary Credential with oauth_verifier
-> m CredentialToken Credential (Access Token & Secret)
Get Access token.
getAccessTokenProxy :: MonadIO m=> Maybe ProxyProxy
-> OAuthOAuth Application
-> CredentialTemporary Credential with oauth_verifier
-> m CredentialToken Credential (Access Token & Secret)
Get Access token via the proxy.
getTokenCredentialProxy :: MonadIO m=> Maybe ProxyProxy
-> OAuthOAuth Application
-> CredentialTemporary Credential with oauth_verifier
-> m CredentialToken Credential (Access Token & Secret)
Get Access token via the proxy.
getAccessToken' :: MonadIO m=> (Request -> Request)Request Hook
-> OAuthOAuth Application
-> CredentialTemporary Credential with oauth_verifier
-> m CredentialToken Credential (Access Token & Secret)