/fga-elixir-sdk

An elixir client for OpenFGA

Primary LanguageElixirApache License 2.0Apache-2.0

OpenFGA

A high performance and flexible authorization/permission engine built for developers and inspired by Google Zanzibar.

Building

To install the required dependencies and to build the elixir project, run:

mix local.hex --force
mix do deps.get, compile

Installation

If available in Hex, the package can be installed by adding openfga_elixir to your list of dependencies in mix.exs:

def deps do
  [{:openfga_elixir, "~> 0.1"}]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/openfga_elixir.

Configuration

You can override the URL of your server (e.g. if you have a separate development and production server in your configuration files).

config :openfga_elixir, base_url: "http://localhost"

Multiple clients for the same API with different URLs can be created passing different base_urls when calling OpenFGA.Connection.new/1:

client = OpenFGA.Connection.new(base_url: "http://localhost")