ueberauth_microsoft

Microsoft Strategy for Überauth

Monthly Downloads: 30,126

Programming language: Elixir

License: MIT License

Tags: Authentication    

Latest version: v0.7.0

README

Überauth Microsoft

Microsoft OAuth2 strategy for Überauth.

Installation

1. Setup your application at the new Microsoft app registration portal.

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

   def deps do
     [{:ueberauth_microsoft, "~> 0.8"}]
   end
   

3. Add the strategy to your applications:

   def application do
     [applications: [:ueberauth_microsoft]]
   end
   

4. Add Microsoft to your Überauth configuration:

   config :ueberauth, Ueberauth,
     providers: [
       microsoft: {Ueberauth.Strategy.Microsoft, []}
     ]
   

5. Update your provider configuration:

   config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
     client_id: System.get_env("MICROSOFT_CLIENT_ID"),
     client_secret: System.get_env("MICROSOFT_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.

Single Tenancy

If you are going to use your app only internally you may need to configure it for a single tenant. To do so you only need to add tenant_id to your provider configuration like:

  config :ueberauth, Ueberauth.Strategy.Microsoft.OAuth,
    tenant_id: System.get_env("MICROSOFT_TENANT_ID"),
    client_id: System.get_env("MICROSOFT_CLIENT_ID"),
    client_secret: System.get_env("MICROSOFT_CLIENT_SECRET")

Calling

Depending on the configured url you can initial the request through:

/auth/microsoft

By default the scopes used are

• openid
• email
• offline_access
• https://graph.microsoft.com/user.read

Note: at least one service scope is required in order for a token to be returned by the Microsoft endpoint

You can configure additional scopes to be used by passing the extra_scopes option into the provider

config :ueberauth, Ueberauth,
  providers: [
    microsoft: {Ueberauth.Strategy.Microsoft, [extra_scopes: "https://graph.microsoft.com/calendars.read"]}
  ]

License

Please see LICENSE for licensing details.