Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jsmestad/ueberauth_slack_v2
Slack OAuth V2 Überauth strategy that supports Bot and User tokens
https://github.com/jsmestad/ueberauth_slack_v2
oauth2 slack ueberauth ueberauth-strategies
Last synced: 2 months ago
JSON representation
Slack OAuth V2 Überauth strategy that supports Bot and User tokens
- Host: GitHub
- URL: https://github.com/jsmestad/ueberauth_slack_v2
- Owner: jsmestad
- License: mit
- Created: 2020-10-31T19:43:58.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-15T01:22:40.000Z (8 months ago)
- Last Synced: 2024-09-16T15:41:24.215Z (4 months ago)
- Topics: oauth2, slack, ueberauth, ueberauth-strategies
- Language: Elixir
- Homepage:
- Size: 86.9 KB
- Stars: 2
- Watchers: 2
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Überauth Slack V2
> Slack V2 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_v2, "~> 2.0"}]
end
```
1. Add Slack to your Überauth configuration:
```elixir
config :ueberauth, Ueberauth,
providers: [
slack: {Ueberauth.Strategy.SlackV2, []}
]
```
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.SlackV2, [team: "0ABCDEF"]}
]
```
1. Update your provider configuration:
```elixir
config :ueberauth, Ueberauth.Strategy.SlackV2.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&user_scope=dnd:write
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.SlackV2, [
default_scope: "users:read,users:write",
default_user_scope: "dnd:write"
]}
]
```
## License
Please see [LICENSE](https://github.com/ueberauth/ueberauth_slack/blob/master/LICENSE) for licensing details.