https://github.com/techgaun/auth0_ex

An elixir client library for Auth0
https://github.com/techgaun/auth0_ex

auth0 elixir hacktoberfest jwt-authentication sdk

Last synced: 28 days ago
JSON representation

An elixir client library for Auth0

• Host: GitHub
• URL: https://github.com/techgaun/auth0_ex
• Owner: techgaun
• License: apache-2.0
• Created: 2016-06-27T07:51:01.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-03-01T04:34:30.000Z (10 months ago)
• Last Synced: 2024-10-18T21:05:13.578Z (about 2 months ago)
• Topics: auth0, elixir, hacktoberfest, jwt-authentication, sdk
• Language: Elixir
• Homepage: https://hex.pm/packages/auth0_ex
• Size: 132 KB
• Stars: 45
• Watchers: 4
• Forks: 28
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nepal - Auth0Ex - Auth0 Client Library for Elixir (Uncategorized / Uncategorized)

README

        
# Auth0Ex

[![Hex version](https://img.shields.io/hexpm/v/auth0_ex.svg "Hex version")](https://hex.pm/packages/auth0_ex) ![Hex downloads](https://img.shields.io/hexpm/dt/auth0_ex.svg "Hex downloads") ![Build Status](https://github.com/techgaun/auth0_ex/actions/workflows/main.yml/badge.svg)

> An elixir client library for Auth0

## Installation

You can install the stable version from hex:

```elixir

def deps do

[{:auth0_ex, "~> 0.9"}]

end

```

You can use github repo as your package source to use the latest source code but beware it might have breaking and unstable code:

```elixir

def deps do

  [{:auth0_ex, github: "techgaun/auth0_ex"}]

end

```

## Configuration

Add a configuration block like below:

- First option is to use management api client.

You can create non-interactive client for management api as described [HERE](https://auth0.com/docs/api/management/v2/tokens).

Once you do that, you should be able to grab client ID and client secret from the setting page for use with Auth0Ex.

This is a recommended setup as Auth0Ex can recreate new `access_token` when the current one expires.

```elixir

config :auth0_ex,

  domain: System.get_env("AUTH0_DOMAIN"),

  mgmt_client_id: System.get_env("AUTH0_MGMT_CLIENT_ID"),

  mgmt_client_secret: System.get_env("AUTH0_MGMT_CLIENT_SECRET"),

  http_opts: []

```

- Second option is to use pre-created token with access to management API.

```elixir

config :auth0_ex,

  domain: System.get_env("AUTH0_DOMAIN"),

  mgmt_token: System.get_env("AUTH0_MGMT_TOKEN"),

  http_opts: []

```

### Notes

- The v2 `search_engine` API is being deprecated by Auth0. User queries now specify `search_engine=v3` by default. If for some reason you need the `v2` engine you can set `v2_search: true` in your config block.

- if you use pre-created management token, it will always be used for your requests.

- `AUTH0_DOMAIN` should be entire tenant domain Auth0 provides. We fall back to adding `auth0.com` right now but that will be removed in future version. This allows us to use `Auth0Ex` in all tenant regions unlike the previous versions.

- If you don't want `auth0.com` to be added, you can set `config :auth0_ex, custom_domain: true`

Export appropriate environment variable and you should be all set.

Please refer to the [documentation](https://hexdocs.pm/auth0_ex/) for more details.

### Authentication API

In addition to the management API resources, there is also a support for most used authentication APIs.

Authentication API will use the same `domain` config you specify in the config above. If you wish to use `Auth0Ex`

for authentication APIs only, all you need to specify is `domain` in config.

## Author

- [techgaun](https://github.com/techgaun)