README.md

# Überauth Okta
Okta strategy for Überauth

## Setup
Add `:ueberauth_okta` to your list of dependencies in mix.exs:

```elixir
def deps do
  [{:ueberauth_okta, "~> 0.2"}]
end
```

Add the strategy to your applications:
```elixir
def application do
  [extra_applications: [:ueberauth_okta]]
end
```

Include the provider in your configuration for Ueberauth
```elixir
config :ueberauth, Ueberauth,
  providers: [
    okta: { Ueberauth.Strategy.Okta, [] }
  ]
```

You'll need to register a new application with Okta and get the `client_id` and `client_secret`. That setup is out of the scope of this library, but some notes to remember are:
  * Ensure `Authorization Code` grant type is enabled
  * You have valid `Login Redirect Urls` listed for the app that correctly reference your callback route(s)
  * `user` and/or `group` permissions may need to be added to your Okta app before successfully authenticating

Then include the configuration for okta.
```elixir
config :ueberauth, Ueberauth.Strategy.Okta.OAuth,
  client_id: System.get_env("OKTA_CLIENT_ID"),
  client_secret: System.get_env("OKTA_CLIENT_SECRET"),
  site: "https://your-doman.okta.com"
```

If you haven't already, create a pipeline and setup routes for your callback handler
```elixir
pipeline :auth do
  plug Ueberauth
end
scope "/auth" do
  pipe_through [:browser, :auth]
  get "/:provider/callback", AuthController, :callback
end
```

Create an endpoint for the callback where you will handle the `Ueberauth.Auth` struct
```elixir
defmodule MyApp.AuthController do
  use MyApp.Web, :controller
  def callback_phase(%{ assigns: %{ ueberauth_failure: fails } } = conn, _params) do
    # do things with the failure
  end
  def callback_phase(%{ assigns: %{ ueberauth_auth: auth } } = conn, params) do
    # do things with the auth
  end
end
```

## Goals
This is just the start `ueberauth_okta` strategy for support with Okta auth protocols. Initially, I will mainly be focused on Okta OAuth, but once that is up I will move onto other autentication routes I'd also like to support (see below):

- [x] OAuth 2.0
- [ ] SAML