Ueberauth.Strategy.Atlassian (ueberauth_atlassian v0.2.0)

Installation

  1. Setup your application at Atlassian Developer Console.

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

    def deps do
      [
        {:ueberauth_atlassian, "~> 0.1.0"}
      ]
    end
  3. Add Atlassian to your Überauth configuration:

    config :ueberauth, Ueberauth,
      providers: [
        atlassian: {Ueberauth.Strategy.Atlassian, []}
      ]
  4. Update your provider configuration:

    Use that if you want to read client ID/secret from the environment variables in the compile time:

    config :ueberauth, Ueberauth.Strategy.Atlassian.OAuth,
      client_id: System.get_env("ATLASSIAN_CLIENT_ID"),
      client_secret: System.get_env("ATLASSIAN_CLIENT_SECRET")

    Use that if you want to read client ID/secret from the environment variables in the run time:

    config :ueberauth, Ueberauth.Strategy.Atlassian.OAuth,
      client_id: {System, :get_env, ["ATLASSIAN_CLIENT_ID"]},
      client_secret: {System, :get_env, ["ATLASSIAN_CLIENT_SECRET"]}
  5. Include the Überauth plug in your controller:

    defmodule MyApp.AuthController do
      use MyApp.Web, :controller
      plug Ueberauth
      ...
    end
  6. 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
  7. Your controller needs to implement callbacks to deal with Ueberauth.Auth and Ueberauth.Failure responses.

For an example implementation see the Überauth Example application.

Calling

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

/auth/atlassian

Or with options:

/auth/atlassian?scope=read%3Ame%20read%3Ajira-work

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

config :ueberauth, Ueberauth,
  providers: [
    atlassian: {Ueberauth.Strategy.Atlassian, [default_scope: "read:me offline_access"]}
  ]

Summary

Functions

Gets called after handle_callback! to set the credentials struct with the token information

Callback implementation for Ueberauth.Strategy.extra/1.

This function will be called by your auth controller callback handler. The user is forwarded to the callback after authentication on Atlassian. The function retrieves the access token and fetches the user details.

Cleanup user information on logout.

The function retrieves exchanges a refresh token for an access token.

This function will be called by your auth controller request handler. It forwards the user to Atlassian for authentication in return it passes back a code to the callback.

Fetches the fields to populate the info section of the Ueberauth.Auth struct.

Fetches the uid field from the response.

Functions

Link to this function

credentials(conn)

Gets called after handle_callback! to set the credentials struct with the token information

Link to this function

default_options()

Callback implementation for Ueberauth.Strategy.extra/1.

Link to this function

handle_callback!(conn)

This function will be called by your auth controller callback handler. The user is forwarded to the callback after authentication on Atlassian. The function retrieves the access token and fetches the user details.

Link to this function

handle_cleanup!(conn)

Cleanup user information on logout.

Link to this function

handle_refresh!(conn, refresh_token)

The function retrieves exchanges a refresh token for an access token.

Link to this function

handle_request!(conn)

This function will be called by your auth controller request handler. It forwards the user to Atlassian for authentication in return it passes back a code to the callback.

Fetches the fields to populate the info section of the Ueberauth.Auth struct.

Fetches the uid field from the response.