Install SDK Client

To get started, install the OpenFGA SDK packages. These commands select the exact versions used by the API reference samples. The API reference provides SDK programs for 18 standard operations and cURL for all 24 operations. The six experimental AuthZen endpoints are HTTP-only in these SDK versions: GetConfiguration, Evaluation, Evaluations, ActionSearch, ResourceSearch, and SubjectSearch. Use their cURL samples; no named SDK methods are available for these endpoints.

You can find the Node.js package on npm at: @openfga/sdk.Using npm:

npm install @openfga/sdk@0.9.7

Using yarn:

yarn add @openfga/sdk@0.9.7

You can find the Go package on GitHub at: @openfga/go-sdk. This SDK version requires Go 1.25 or newer.To install:

go get github.com/openfga/go-sdk@v0.8.2

In your code, import the module and use it:

import (
    openfga "github.com/openfga/go-sdk"
)

func main() {
    configuration, err := openfga.NewConfiguration(openfga.Configuration{
        ApiUrl: os.Getenv("FGA_API_URL"), // required, e.g. https://api.fga.example
    })
    if err != nil {
        // .. Handle error
    }
}

You can then run

go mod tidy

to update go.mod and go.sum if you are using them.

The OpenFGA .NET SDK is available on NuGet. The API reference programs use top-level statements and async streams; use a .NET 8 or newer application.You can install it using:

The dotnet CLI:

dotnet add package OpenFGA.Sdk --version 0.10.4

The Package Manager Console inside Visual Studio:

Install-Package OpenFGA.Sdk -Version 0.10.4

Visual Studio, Visual Studio for Mac and IntelliJ Rider: Search for and install OpenFGA.Sdk in each of their respective package manager UIs.

The OpenFGA Python SDK is available on PyPI.To install:

pip3 install openfga_sdk==0.10.4

In your code, import the module and use it:

import openfga_sdk

You can find the Java package on Maven Central. This SDK version requires Java 17 or newer.Using Maven:

<dependency>
    <groupId>dev.openfga</groupId>
    <artifactId>openfga-sdk</artifactId>
    <version>0.10.0</version>
</dependency>

Using Gradle:

implementation 'dev.openfga:openfga-sdk:0.10.0'

The OpenFGA CLI is available on GitHub.To install:

Brew

brew install openfga/tap/fga

Linux (deb, rpm and apk) packages

Download the .deb, .rpm or .apk packages from the releases page.Debian:

sudo apt install ./fga_<version>_linux_<arch>.deb

Fedora:

sudo dnf install ./fga_<version>_linux_<arch>.rpm

Alpine Linux:

sudo apk add --allow-untrusted ./fga_<version>_linux_<arch>.apk

Docker

docker pull openfga/cli; docker run -it openfga/cli

Go

go install github.com/openfga/cli/cmd/fga@latest

Manually

Download the pre-compiled binaries from the releases page.

Get OpenFGA’s SDKs to add authorization to your API.

OpenFGA Node.js SDK

Install our Node.js & JavaScript SDK to get started.

OpenFGA Go SDK

Use our Go SDK to easily connect your Go application to the OpenFGA API

OpenFGA .NET SDK

Connect your .NET service with OpenFGA using our .NET SDK

OpenFGA Python SDK

Connect your Python service with OpenFGA using our Python SDK

OpenFGA Java SDK

Connect your Java service with OpenFGA using our Java SDK

Getting Started

Modeling Guides

Authorization for Agents

Interacting with the API

Best Practices

Industries

Use Cases

Adopters

Learn

Install SDK Client

Brew

Linux (deb, rpm and apk) packages

Docker

Go

Manually

OpenFGA Node.js SDK

OpenFGA Go SDK

OpenFGA .NET SDK

OpenFGA Python SDK

OpenFGA Java SDK

​Brew

​Linux (deb, rpm and apk) packages

​Docker

​Go

​Manually

​Related Sections

OpenFGA Node.js SDK

OpenFGA Go SDK

OpenFGA .NET SDK

OpenFGA Python SDK

OpenFGA Java SDK

Brew

Linux (deb, rpm and apk) packages

Docker

Go

Manually

Related Sections