Web.Authenticate.OAuth.IO

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

Service name (default: "")

URI to request temporary credential (default: ""). You MUST specify if you use getTemporaryCredential', getTemporaryCredentialProxy or getTemporaryCredential; otherwise you can just leave this empty.

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

Signature Method (default: HMACSHA1)

Consumer key (You MUST specify)

Consumer Secret (You MUST specify)

Callback uri to redirect after authentication (default: Nothing)

Optional authorization realm (default: Nothing)

OAuth spec version (default: OAuth10a)

The default value for this type.

Default value for OAuth datatype. You must specify at least oauthServerName, URIs and Tokens.

Data type for signature method.

Data type for credential.

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

Request Hook.

Default: id

Since 1.5.1

OAuth Application

Since 1.5.1

Temporary Credential (with oauth_verifier if >= 1.0a)

Since 1.5.1

Manager

Since 1.5.1

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

Convenient function to create Credential with OAuth Token and Token Secret.

Empty credential.

Insert an oauth parameter into given Credential.

Remove an oauth parameter for key from given Credential.

Convenient method for inserting multiple parameters into credential.

Insert oauth-verifier on a Credential.

Add OAuth headers & sign to Request.

Generate OAuth signature. Used by signOAuth.

Test existing OAuth signature. Since 1.5.2

URL to obtain OAuth verifier.

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.

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

Encode a string using the percent encoding method for OAuth.

Get Access token.

Get temporary credential for requesting acces token.

Get temporary credential for requesting access token with Scope parameter.

Get temporary credential for requesting access token via the proxy.

Get Access token.

Get Access token via the proxy.

Get Access token via the proxy.