mirror of
https://github.com/freckle/yesod-auth-oauth2.git
synced 2026-01-18 15:11:57 +01:00
78 lines
1.6 KiB
Markdown
78 lines
1.6 KiB
Markdown
# Yesod.Auth.OAuth2
|
|
|
|
OAuth2 `AuthPlugin`s for Yesod.
|
|
|
|
## Basic Usage
|
|
|
|
To use one of the supported providers:
|
|
|
|
```haskell
|
|
import Yesod.Auth
|
|
import Yesod.Auth.OAuth2.Github
|
|
|
|
instance YesodAuth App where
|
|
-- ...
|
|
|
|
authPlugins _ = [oauth2Github clientId clientSecret]
|
|
|
|
clientId :: Text
|
|
clientId = "..."
|
|
|
|
clientSecret :: Text
|
|
clientSecret = "..."
|
|
```
|
|
|
|
Some plugins, such as GitHub and Slack, have scoped functions for requesting
|
|
additional information:
|
|
|
|
```haskell
|
|
import Yesod.Auth
|
|
import Yesod.Auth.OAuth2.Slack
|
|
|
|
instance YesodAuth App where
|
|
-- ...
|
|
|
|
authPlugins _ =
|
|
[oauth2SlackScoped clientId clientSecret slackScopes]
|
|
where
|
|
slackScopes = [SlackEmailScope, SlackAvatarScope, SlackTeamScope]
|
|
|
|
clientId :: Text
|
|
clientId = "..."
|
|
|
|
clientSecret :: Text
|
|
clientSecret = "..."
|
|
```
|
|
|
|
## Advanced Usage
|
|
|
|
To use any other provider:
|
|
|
|
```haskell
|
|
import Yesod.Auth
|
|
import Yesod.Auth.OAuth2
|
|
|
|
instance YesodAuth App where
|
|
-- ...
|
|
|
|
authPlugins _ = [myPlugin]
|
|
|
|
myPlugin :: AuthPlugin m
|
|
myPlugin = authOAuth2 "mysite"
|
|
(OAuth2
|
|
{ oauthClientId = "..."
|
|
, oauthClientSecret = "..."
|
|
, oauthOAuthorizeEndpoint = "https://mysite.com/oauth/authorize"
|
|
, oauthAccessTokenEndpoint = "https://mysite.com/oauth/token"
|
|
, oauthCallback = Nothing
|
|
})
|
|
makeCredentials
|
|
|
|
makeCredentials :: Manager -> AccessToken -> IO (Creds m)
|
|
makeCredentials manager token = do
|
|
result <- authGetJSON manager token "https://mysite.com/api/me.json"
|
|
return $ -- Parse the JSON into (Creds m)
|
|
```
|
|
|
|
*If you write one of these, please consider opening a Pull Request*
|