Skip to content
Slack OAuth2 Strategy for Überauth
Branch: master
Clone or download
ibash and doomspork Support Sign in with Slack tokens (#31)
If you use "Sign in with Slack" then the token recieved can't access the
"auth.test" endpoint. Instead the identity needs to be fetched from the
"users.identity" endpoint.

This change makes the slack strategy fetch the identity in addition to
the auth wheth the "identity.basic" scope is present.

Note that the strategy always attempts to fetch the auth because
sometimes the token can access _both_ endpoints (say if the scope has
"users:read" _and_ "identity.basic"). The difference is that if the
"identity.basic" scope is present we don't consider an "invalid_auth"
response from the "auth.test" endpoint to be an error case.

ref: https://api.slack.com/docs/sign-in-with-slack
Latest commit 525594c Apr 11, 2019

README.md

Überauth Slack

Slack OAuth2 strategy for Überauth.

Installation

  1. Setup your application at Slack API.

  2. Add :ueberauth_slack to your list of dependencies in mix.exs:

    def deps do
      [{:ueberauth_slack, "~> 0.5"}]
    end
  3. Add the strategy to your applications:

    def application do
      [applications: [:ueberauth_slack]]
    end
  4. Add Slack to your Überauth configuration:

    config :ueberauth, Ueberauth,
      providers: [
        slack: {Ueberauth.Strategy.Slack, []}
      ]

    You can optionally restrict authentication by providing your team ID. Find your Slack team ID here. Note that this is NOT your team's Slack domain name!

    config :ueberauth, Ueberauth,
      providers: [
        slack: {Ueberauth.Strategy.Slack, [team: "0ABCDEF"]}
      ]
  5. Update your provider configuration:

    config :ueberauth, Ueberauth.Strategy.Slack.OAuth,
      client_id: System.get_env("SLACK_CLIENT_ID"),
      client_secret: System.get_env("SLACK_CLIENT_SECRET")
  6. Include the Überauth plug in your controller:

    defmodule MyApp.AuthController do
      use MyApp.Web, :controller
      plug Ueberauth
      ...
    end
  7. Create the request and callback routes if you haven't already:

    scope "/auth", MyApp do
      pipe_through :browser
    
      get "/:provider", AuthController, :request
      get "/:provider/callback", AuthController, :callback
    end
  8. Your controller needs to implement callbacks to deal with Ueberauth.Auth and Ueberauth.Failure responses.

For an example implementation see the Überauth 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:

config :ueberauth, Ueberauth,
  providers: [
    slack: {Ueberauth.Strategy.Slack, [default_scope: "users:read,users:write"]}
  ]

License

Please see LICENSE for licensing details.

You can’t perform that action at this time.