Intercom OAuth2 Strategy for OmniAuth.
Supports the OAuth 2.0 server-side and client-side flows. Read the Intercom OAuth docs for more details:
Add to your Gemfile:
gem'omniauth-intercom','~> 0.1.9'Then bundle install.
Important For this to work you need to select the read_single_admin permissions in your OAuth application to use this middleware.
Important You will also need to ensure your redirect_url is set to /auth/intercom/callback
OmniAuth::Strategies::Intercom is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.
Here's a quick example, adding the middleware to a Rails app in config/initializers/omniauth.rb:
Rails.application.config.middleware.useOmniAuth::Builderdoprovider:intercom,ENV['INTERCOM_KEY'],ENV['INTERCOM_SECRET']endTo start the authentication process with Intercom you simply need to access /auth/intercom route.
You can start the authentication process directly with the signup page by accessing /auth/intercom?signup=1
Important Reminder: As noted earlier you need the read_single_admin permissions to use this middleware.
Important Reminder: As noted earlier your redirect_url should be /auth/intercom/callback
By default Intercom strategy rejects users with unverified email addresses. info and raw_info in request.env['omniauth.auth'] will not be populated in that case.
To disable this check add verify_email: false to your config:
Rails.application.config.middleware.useOmniAuth::Builderdoprovider:intercom,ENV['INTERCOM_KEY'],ENV['INTERCOM_SECRET'],verify_email: falseendHere's an example Auth Hash available in request.env['omniauth.auth']:
{:provider=>'intercom',:uid=>'342324',:info=>{:email=>'kevin.antoine@intercom.io',:name=>'Kevin Antoine'},:credentials=>{:token=>'<redacted>',# OAuth 2.0 access_token, which you may wish to store:expires=>false},:extra=>{:raw_info=>{:name=>'Kevin Antoine',:email=>'kevin.antoine@intercom.io',:type=>'admin',:id=>'342324',:email_verified=>true,:app=>{:id_code=>'abc123',# Company app_id:type=>'app',:secure=>true,# Secure mode enabled for this app:timezone=>"Dublin",:name=>"ProjectMap"},:avatar=>{:image_url=>"https://static.intercomassets.com/avatars/343616/square_128/me.jpg?1454165491"}}}}To use Intercom Button to display authentication in a popup it is simple :
- Add the following code in the html file in which you want to start to authenticate with Intercom (
/views/home/index.html.erbif you want to authenticate with Intercom inhome#index)
<ahref="javascript:void(0)" class="intercom-oauth-cta"><imgsrc="https://static.intercomassets.com/assets/oauth/primary-7edb2ebce84c088063f4b86049747c3a.png" srcset="https://static.intercomassets.com/assets/oauth/primary-7edb2ebce84c088063f4b86049747c3a.png 1x, https://static.intercomassets.com/assets/oauth/primary@2x-0d69ca2141dfdfa0535634610be80994.png 2x, https://static.intercomassets.com/assets/oauth/primary@3x-788ed3c44d63a6aec3927285e920f542.png 3x"/></a><scripttype="text/javascript">$('.intercom-oauth-cta').unbind('click').click(function(){varauth_window=window.open('/auth/intercom','Sign in','width=700,height=450');varcheckWindow=function(){if(auth_window.closed){window.location='/';}elseif(window.oauth_success===undefined){setTimeout(checkWindow,200);}};checkWindow();});</script>Create a views/home/intercom_callback.html.erb file ( if your callback route is home#intercom_callback)
<html><head><title>Authorized</title></head><body><scripttype="text/javascript">setTimeout(function(){if(window.opener){window.opener.oauth_success=true;}window.close();},1000);</script></body></html>From v0.1.4 we have defined our omniauth-oauth2 dependency to allow any version from 1.2 on. If you relied on our Gemspec version config for omniauth-oauth2 you can simply add gem 'omniauth-oauth2', '~> 1.2' to your Gemfile. This will ensure your omniauth-oauth2 version is 1.2.x again.