Kinde Elixir SDK

The Kinde Elixir SDK allows developers to use this library for the Kinde Business.

Register for Kinde

If you haven’t already got a Kinde account, register for free here (no credit card required).

You need a Kinde domain to get started, e.g. yourapp.kinde.com.

Installation

Add the following dependency in your project:

{:kinde_sdk, path: "/path/to/kinde-elixir-sdk"}

and add to your extra applications:

def application do
  [
    extra_applications: [:logger, :kinde_sdk]
  ]
end

Configuration of API Keys

You need to follow these steps to setup the project properly:

1. Create .env file at the root

2. Add the following lines in there:

   export KINDE_BACKEND_CLIENT_ID="6c43a124bc114dc0bf78889ae89349b3"
   export KINDE_FRONTEND_CLIENT_ID="2e41e9e798004177b1b44aa1e1ad3d62"
   export KINDE_CLIENT_SECRET="Tz9oKlQGW1VJX2FUoLdaeUHjCMnlNccHTW1fyOWlO4krBb4P1G"
   export KINDE_REDIRECT_URL="http://localhost:4000/callback"
   export KINDE_DOMAIN="https://elixirsdk2.kinde.com"
   export KINDE_LOGOUT_REDIRECT_URL="http://localhost:4000/logout"
   export KINDE_PKCE_LOGOUT_URL="http://localhost:4000/logout"
   export KINDE_PKCE_REDIRECT_URL="http://localhost:4000/pkce-callback"
   export KINDE_BASE_URL="https://app.kinde.com"

3. Don’t forget to update the values of above keys with your kinde-account keys to make the app up and running.

4. Optionally, you can also set scope as well.

   config :kinde_sdk, scope: "email"

5. Once you’re done with above steps, open the console and write source .env before any mix command.

6. Note: This configuration is very important, you won’t be able to compile the project, as well as no tests will run successfully until you follow these steps.

Configuration of kinde_sdk in Existing Project

You need to follow these steps to setup the existing project properly:

1. Create .env file at the root
2. Add the following lines in there:

   export KINDE_BACKEND_CLIENT_ID="6c43a124bc114dc0bf78889ae89349b3"
   export KINDE_FRONTEND_CLIENT_ID="2e41e9e798004177b1b44aa1e1ad3d62"
   export KINDE_CLIENT_SECRET="Tz9oKlQGW1VJX2FUoLdaeUHjCMnlNccHTW1fyOWlO4krBb4P1G"
   export KINDE_REDIRECT_URL="http://localhost:4000/callback"
   export KINDE_DOMAIN="https://elixirsdk2.kinde.com"
   export KINDE_LOGOUT_REDIRECT_URL="http://localhost:4000/logout"
   export KINDE_PKCE_LOGOUT_URL="http://localhost:4000/logout"
   export KINDE_PKCE_REDIRECT_URL="http://localhost:4000/pkce-callback"
   export KINDE_BASE_URL="https://app.kinde.com"

3. Don’t forget to replace the values to your own application-keys, these are just dummy keys (might not work)
4. Also make sure that your project has runtime.exs file in the config directory which has following piece of code written in it:

   import Config
   import Envar
   Envar.load(".env")
   # configure kinde_sdk on runtime
   config :kinde_sdk,
   backend_client_id: Envar.get("KINDE_BACKEND_CLIENT_ID"),
   frontend_client_id: Envar.get("KINDE_FRONTEND_CLIENT_ID"),
   client_secret: Envar.get("KINDE_CLIENT_SECRET"),
   redirect_url: Envar.get("KINDE_REDIRECT_URL"),
   domain: Envar.get("KINDE_DOMAIN"),
   logout_redirect_url: Envar.get("KINDE_LOGOUT_REDIRECT_URL"),
   pkce_logout_url: Envar.get("KINDE_PKCE_LOGOUT_URL"),
   pkce_callback_url: Envar.get("KINDE_PKCE_REDIRECT_URL")

Usage

Initialize your client like this:

{conn, client} =
  KindeClientSDK.init(
    conn,
    Application.get_env(:kinde_sdk, :domain),
    Application.get_env(:kinde_sdk, :redirect_url),
    Application.get_env(:kinde_sdk, :backend_client_id),
    Application.get_env(:kinde_sdk, :client_secret),
    :client_credentials,
    Application.get_env(:kinde_sdk, :logout_redirect_url)
  )

OAuth Flows (Grant Types)

KindeClientSDK implements three OAuth flows: Client Credentials flow, Authorisation Code flow and Authorisation Code with PKCE flow. Each flow can be used with their corresponding grant type when initializing a client.

ETS Cache

KindeClientSDK implements persistant ETS cache for storing the client data and authenticating variables.

You may call your created client like this:

client = KindeClientSDK.get_kinde_client(conn)

Login

conn = KindeClientSDK.login(conn, client)

Register

conn = KindeClientSDK.register(conn, client)

Callbacks

When the user is redirected back to your site from Kinde, this will call your callback URL defined in the redirect_url config. You will need to route /callback to call a function to handle this.

def callback(conn, _params) do
  {conn, client} = KindeClientSDK.get_token(conn)

  data = KindeClientSDK.get_all_data(conn)
  IO.inspect(data.access_token, label: "kinde_access_token") # Tip: This line is not mandatory, as its just console-printing
end

Tokens

We can use Kinde helper function to get the tokens generated by login and get_token functions.

data = KindeClientSDK.get_all_data(conn)
IO.inspect(data.login_time_stamp, label: "Login Time Stamp") # Tip: This line is not mandatory, as its just console-printing

Or first calling the get_token function:

{conn, client} = KindeClientSDK.get_token(conn)

User details

You need to have already authenticated before you call the API, otherwise an error will occur.

KindeClientSDK.get_user_detail(conn)

Create an organization

To have a new organization created within your application

conn = KindeClientSDK.create_org(conn, client)
conn = KindeClientSDK.create_org(conn, client)

Logout

The Kinde SDK client comes with a logout method.

conn = KindeClientSDK.logout(conn)

Authenticated

Returns whether if a user is logged in.

KindeClientSDK.authenticated?(conn)

Claims

We have provided a helper to grab any claim from your id or access tokens. The helper defaults to access tokens:

KindeClientSDK.get_claims(conn)
KindeClientSDK.get_claim(conn, "jti", :id_token)

Permissions

We provide helper functions to more easily access permissions:

KindeClientSDK.get_permissions(conn)
KindeClientSDK.get_permission(conn, "create:users")

See Define user permissions.

Audience

An audience is the intended recipient of an access token - for example the API for your application. The audience argument can be passed to the Kinde client to request an audience be added to the provided token.

additional_params = %{
      audience: "api.yourapp.com"
    }

KindeClientSDK.init(
    conn,
    Application.get_env(:kinde_sdk, :domain),
    Application.get_env(:kinde_sdk, :redirect_url),
    Application.get_env(:kinde_sdk, :backend_client_id),
    Application.get_env(:kinde_sdk, :client_secret),
    :authorization_code_flow_pkce,
    Application.get_env(:kinde_sdk, :logout_redirect_url),
    "openid profile email offline",
    additional_params
  )

For details on how to connect, see Register an API

Overriding scope

By default the KindeSDK requests the following scopes:

• profile
• email
• offline
• openid

You can override this by passing scope into the KindeSDK.

kinde SDK Reference

SDK Functions

Feature Flag Helper Functions