Repository files navigation

Instagram OAuth2 strategy for Überauth.

1. Setup your application atInstagram Developers.

2. Add:ueberauth_instagram to your list of dependencies inmix.exs:

   defdepsdo[{:ueberauth_instagram,"~> 0.1"}]end

3. Add the strategy to your applications:

   defapplicationdo[applications:[:ueberauth_instagram]]end

4. Add Instagram to your Überauth configuration:

   config:ueberauth,Ueberauth,providers:[instagram:{Ueberauth.Strategy.Instagram,[]}]

5. Update your provider configuration:

   config:ueberauth,Ueberauth.Strategy.Instagram.OAuth,client_id:System.get_env("INSTAGRAM_CLIENT_ID"),client_secret:System.get_env("INSTAGRAM_CLIENT_SECRET")

6. Include the Überauth plug in your controller:

   defmoduleMyApp.AuthControllerdouseMyApp.Web,:controllerplugUeberauth...end

7. Create the request and callback routes if you haven't already:

   scope"/auth",MyAppdopipe_through:browserget"/:provider",AuthController,:requestget"/:provider/callback",AuthController,:callbackend

8. Your controller needs to implement callbacks to deal withUeberauth.Auth andUeberauth.Failure responses.

For an example implementation see theÜberauth Example application.

Depending on the configured URL you can initialize the request through:

/auth/instagram

Or with options:

/auth/instagram?scope=basic

By default the requested scope is "public_content". Scope can be configured either explicitly as ascope query value on the request path or in your configuration:

config:ueberauth,Ueberauth,providers:[instagram:{Ueberauth.Strategy.Instagram,[default_scope:"basic,public_content,followers_list"]}]

SeeInstagram API Reference > Login Permissions for full list of scopes.

Please seeLICENSE for licensing details.