Omniauth Azure Active Directory V2 Strategy

Strategy to authenticate with Microsoft Azure Active Directory in OmniAuth.

Get your API key at : https://portal.azure.com/

For more details, read the Microsoft docs: https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-overview

Installation

Add this line to your application's Gemfile:

gem 'moneyforward-omniauth-azure-activedirectory-v2', require: 'omniauth-azure-activedirectory-v2'

And then execute:

bundle install

Usage

Here's an example for adding the middleware to a Rails app in config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
    provider :azure_activedirectory_v2, ENV.fetch('MICROSOFT_OAUTH_CLIENT_ID'), ENV.fetch('MICROSOFT_OAUTH_CLIENT_SECRET'),
        {
            tenant: 'tenant_id',
            response_type: 'code',
            response_mode: 'query',
            uid_field: 'oid',
            scope: 'openid profile email User.Read'
        }
end

or you can define listed options as below by on the fly way:

prompt login_hint domain_hint

Options

tenant

A tenant option is the same as written in official document. See this for details.

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 tags, and push the .gem file to rubygems.org.

Contributing

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

License

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