Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ueberauth/ueberauth_slack
Slack OAuth2 Strategy for Überauth
https://github.com/ueberauth/ueberauth_slack
oauth oauth2 slack strategy ueberauth ueberauth-strategies
Last synced: 3 days ago
JSON representation
Slack OAuth2 Strategy for Überauth
- Host: GitHub
- URL: https://github.com/ueberauth/ueberauth_slack
- Owner: ueberauth
- License: mit
- Created: 2015-11-16T18:01:56.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-05-07T16:56:45.000Z (over 2 years ago)
- Last Synced: 2024-10-30T16:58:29.242Z (4 days ago)
- Topics: oauth, oauth2, slack, strategy, ueberauth, ueberauth-strategies
- Language: Elixir
- Homepage:
- Size: 63.5 KB
- Stars: 23
- Watchers: 7
- Forks: 33
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- fucking-awesome-elixir - ueberauth_slack - A Slack strategy for Überauth. (Authentication)
- awesome-elixir - ueberauth_slack - A Slack strategy for Überauth. (Authentication)
- freaking_awesome_elixir - Elixir - A Slack strategy for Ãberauth. (Authentication)
README
# Überauth Slack
> Slack OAuth2 strategy for Überauth.
## Installation
1. Setup your application at [Slack API](https://api.slack.com).
1. Add `:ueberauth_slack` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:ueberauth_slack, "~> 0.7"}]
end
```
1. Add the strategy to your applications:
```elixir
def application do
[applications: [:ueberauth_slack]]
end
```
1. Add Slack to your Überauth configuration:
```elixir
config :ueberauth, Ueberauth,
providers: [
slack: {Ueberauth.Strategy.Slack, []}
]
```
You can optionally restrict authentication by providing your team ID. [Find your Slack team ID here](https://api.slack.com/methods/auth.test/test). Note that this is NOT your team's Slack domain name!
```elixir
config :ueberauth, Ueberauth,
providers: [
slack: {Ueberauth.Strategy.Slack, [team: "0ABCDEF"]}
]
```
1. Update your provider configuration:
```elixir
config :ueberauth, Ueberauth.Strategy.Slack.OAuth,
client_id: System.get_env("SLACK_CLIENT_ID"),
client_secret: System.get_env("SLACK_CLIENT_SECRET")
```
1. Include the Überauth plug in your controller:
```elixir
defmodule MyApp.AuthController do
use MyApp.Web, :controller
plug Ueberauth
...
end
```
1. Create the request and callback routes if you haven't already:
```elixir
scope "/auth", MyApp do
pipe_through :browser
get "/:provider", AuthController, :request
get "/:provider/callback", AuthController, :callback
end
```
1. Your controller needs to implement callbacks to deal with `Ueberauth.Auth` and `Ueberauth.Failure` responses.
For an example implementation see the [Überauth Example](https://github.com/ueberauth/ueberauth_example) application.
## Calling
Depending on the configured url you can initiate the request through:
/auth/slack
Or with options:
/auth/slack?scope=users:read
By default the requested scope is "users:read". Scope can be configured either explicitly as a `scope` query value on the request path or in your configuration:
```elixir
config :ueberauth, Ueberauth,
providers: [
slack: {Ueberauth.Strategy.Slack, [default_scope: "users:read,users:write"]}
]
```
## License
Please see [LICENSE](https://github.com/ueberauth/ueberauth_slack/blob/master/LICENSE) for licensing details.