Omniauth::SignInWithSlack

An Omniauth plugin for the new Sign in With Slack flow, which is based on OIDC, an extension of OAuth 2.

Installation

First, you need to already have Omniauth installed and set up in your application.

Then, run bundle add omniauth-sign-in-with-slack.

Usage

Follow the Slack instructions to create a Slack App. After that, browse to "Basic Information" under "Settings", and scroll to the section named "App Credentials". Use the Client ID and Client Secret to configure this gem as an Omniauth provider.

With Omniauth & Devise

If you are using Omniauth with Devise, add these lines to your devise.rb configuration file:

config.omniauth :slack, ENV["SLACK_CLIENT_ID"], ENV["SLACK_CLIENT_SECRET"]

With Omniauth

If you are using Omniauth directly, your configuration will look something like this:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :slack, ENV["SLACK_CLIENT_ID"], ENV["SLACK_CLIENT_SECRET"]
end

Configuration

You may provide an options hash as the third argument when configuring the provider. Valid options include anything declared by the OmniAuth::Strategies::OpenIDConnect class. The defaults for this provider are:

  1. name, default value "slack"
  2. issuer, default value "https://slack.com"
  3. scope, default value "openid email profile"

It should not be necessary to set any options for OmniAuth to successfully handle the Sign In With Slack flow.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/indirect/omniauth-sign_in_with_slack. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Omniauth::SignInWithSlack project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.