Java SDK for OpenFGA

This is an autogenerated Java SDK for OpenFGA. It provides a wrapper around the OpenFGA API definition.

Table of Contents

• About OpenFGA
• Resources
• Installation
• Getting Started
  • Initializing the API Client
  • Custom Headers
  • Get your Store ID
  • Calling the API
    • Stores
      • List All Stores
      • Create a Store
      • Get a Store
      • Delete a Store
    • Authorization Models
      • Read Authorization Models
      • Write Authorization Model
      • Read a Single Authorization Model
      • Read the Latest Authorization Model
    • Relationship Tuples
      • Read Relationship Tuple Changes (Watch)
      • Read Relationship Tuples
      • Write (Create and Delete) Relationship Tuples
    • Relationship Queries
      • Check
      • Batch Check
      • Expand
      • List Objects
      • List Relations
      • List Users
    • Assertions
      • Read Assertions
      • Write Assertions
  • Calling Other Endpoints
  • Retries
  • API Endpoints
  • Models
  • OpenTelemetry
• Contributing
  • Issues
  • Pull Requests
• License

About

OpenFGA is an open source Fine-Grained Authorization solution inspired by Google's Zanzibar paper. It was created by the FGA team at Auth0 based on Auth0 Fine-Grained Authorization (FGA), available under a permissive license (Apache-2) and welcomes community contributions.

OpenFGA is designed to make it easy for application builders to model their permission layer, and to add and integrate fine-grained authorization into their applications. OpenFGA’s design is optimized for reliability and low latency at a high scale.

Resources

• OpenFGA Documentation
• OpenFGA API Documentation
• X
• OpenFGA Community
• Zanzibar Academy
• Google's Zanzibar Paper (2019)

Installation

The OpenFGA Java SDK is available on Maven Central.

The OpenFGA Java SDK currently supports Java 17 as the minimum JDK version.

It can be used with the following:

• Gradle (Groovy)

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

• Gradle (Kotlin)

implementation("dev.openfga:openfga-sdk:0.10.0")

• Apache Maven

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

• Ivy

<dependency org="dev.openfga" name="openfga-sdk" rev="0.10.0"/>

• SBT

libraryDependencies += "dev.openfga" % "openfga-sdk" % "0.10.0"

• Leiningen

[dev.openfga/openfga-sdk "0.10.0"]

Getting Started

Initializing the API Client

Learn how to initialize your SDK

We strongly recommend you initialize the OpenFgaClient only once and then re-use it throughout your app, otherwise you will incur the cost of having to re-initialize multiple times or at every request, the cost of reduced connection pooling and re-use, and would be particularly costly in the client credentials flow, as that flow will be preformed on every request.

The Client will by default retry API requests up to 3 times. Rate limiting (429) errors are always retried. Server errors (5xx) are retried for all operations, with delay calculation using Retry-After headers when provided or exponential backoff as fallback.

No Credentials

import com.fasterxml.jackson.databind.ObjectMapper;
import dev.openfga.sdk.api.client.OpenFgaClient;
import dev.openfga.sdk.api.configuration.ClientConfiguration;
import java.net.http.HttpClient;

public class Example {
    public static void main(String[] args) throws Exception {
        var config = new ClientConfiguration()
                .apiUrl(System.getenv("FGA_API_URL")) // If not specified, will default to "http://localhost:8080"
                .storeId(System.getenv("FGA_STORE_ID")) // Not required when calling createStore() or listStores()
                .authorizationModelId(System.getenv("FGA_MODEL_ID")); // Optional, can be overridden per request

        var fgaClient = new OpenFgaClient(config);
        var response = fgaClient.readAuthorizationModels().get();
    }
}

API Token

import com.fasterxml.jackson.databind.ObjectMapper;
import dev.openfga.sdk.api.client.OpenFgaClient;
import dev.openfga.sdk.api.configuration.ApiToken;
import dev.openfga.sdk.api.configuration.ClientConfiguration;
import dev.openfga.sdk.api.configuration.Credentials;
import java.net.http.HttpClient;

public class Example {
    public static void main(String[] args) throws Exception {
        var config = new ClientConfiguration()
                .apiUrl(System.getenv("FGA_API_URL")) // If not specified, will default to "http://localhost:8080"
                .storeId(System.getenv("FGA_STORE_ID")) // Not required when calling createStore() or listStores()
                .authorizationModelId(System.getenv("FGA_MODEL_ID")) // Optional, can be overridden per request
                .credentials(new Credentials(
                    new ApiToken(System.getenv("FGA_API_TOKEN")) // will be passed as the "Authorization: Bearer ${ApiToken}" request header
                ));

        var fgaClient = new OpenFgaClient(config);
        var response = fgaClient.readAuthorizationModels().get();
    }
}

Client Credentials

import com.fasterxml.jackson.databind.ObjectMapper;
import dev.openfga.sdk.api.client.OpenFgaClient;
import dev.openfga.sdk.api.configuration.ClientConfiguration;
import dev.openfga.sdk.api.configuration.ClientCredentials;
import dev.openfga.sdk.api.configuration.Credentials;
import java.net.http.HttpClient;

public class Example {
    public static void main(String[] args) throws Exception {
        var config = new ClientConfiguration()
                .apiUrl(System.getenv("FGA_API_URL")) // If not specified, will default to "http://localhost:8080"
                .storeId(System.getenv("FGA_STORE_ID")) // Not required when calling createStore() or listStores()
                .authorizationModelId(System.getenv("FGA_MODEL_ID")) // Optional, can be overridden per request
                .credentials(new Credentials(
                    new ClientCredentials()
                            .apiTokenIssuer(System.getenv("FGA_API_TOKEN_ISSUER")) // Full token endpoint URL, e.g. "https://issuer.fga.example/oauth/token"
                            .apiAudience(System.getenv("FGA_API_AUDIENCE"))
                            .clientId(System.getenv("FGA_CLIENT_ID"))
                            .clientSecret(System.getenv("FGA_CLIENT_SECRET"))
                ));

        var fgaClient = new OpenFgaClient(config);
        var response = fgaClient.readAuthorizationModels().get();
    }
}

OAuth2 Client Credentials

The SDK supports standard OAuth2 client credentials flow for any OAuth2-compliant provider (e.g. Keycloak, Okta). The apiAudience parameter is optional, and an optional scopes parameter can be provided as a space-separated string. The apiTokenIssuer can be set to either a hostname (e.g. issuer.example.com, which defaults to https and appends /oauth/token) or a full token endpoint URL (e.g. https://mykeycloak.fga.example/realms/myrealm/protocol/openid-connect/token).

import com.fasterxml.jackson.databind.ObjectMapper;
import dev.openfga.sdk.api.client.OpenFgaClient;
import dev.openfga.sdk.api.configuration.ClientConfiguration;
import dev.openfga.sdk.api.configuration.ClientCredentials;
import dev.openfga.sdk.api.configuration.Credentials;
import java.net.http.HttpClient;

public class Example {
    public static void main(String[] args) throws Exception {
        var config = new ClientConfiguration()
                .apiUrl(System.getenv("FGA_API_URL")) // If not specified, will default to "http://localhost:8080"
                .storeId(System.getenv("FGA_STORE_ID")) // Not required when calling createStore() or listStores()
                .authorizationModelId(System.getenv("FGA_MODEL_ID")) // Optional, can be overridden per request
                .credentials(new Credentials(
                    new ClientCredentials()
                            .apiTokenIssuer(System.getenv("FGA_API_TOKEN_ISSUER")) // Full token endpoint URL, e.g. "https://mykeycloak.fga.example/realms/myrealm/protocol/openid-connect/token"
                            .scopes(System.getenv("FGA_API_SCOPES")) // Optional, space-separated scopes
                            .clientId(System.getenv("FGA_CLIENT_ID"))
                            .clientSecret(System.getenv("FGA_CLIENT_SECRET"))
                ));

        var fgaClient = new OpenFgaClient(config);
        var response = fgaClient.readAuthorizationModels().get();
    }
}

Custom Headers

Default Headers

You can set default headers to be sent with every request by using the defaultHeaders property of the ClientConfiguration class.

import com.fasterxml.jackson.databind.ObjectMapper;
import dev.openfga.sdk.api.client.OpenFgaClient;
import dev.openfga.sdk.api.configuration.ClientConfiguration;

import java.net.http.HttpClient;
import java.util.Map;

public class Example {
    public static void main(String[] args) throws Exception {
        var config = new ClientConfiguration()
                .apiUrl(System.getenv("FGA_API_URL"))
                .storeId(System.getenv("FGA_STORE_ID"))
                .authorizationModelId(System.getenv("FGA_MODEL_ID"))
                .defaultHeaders(Map.of(
                        "X-Custom-Header", "default-value",
                        "X-Request-Source", "my-app"
                ));

        var fgaClient = new OpenFgaClient(config);
    }
}

Per-request Headers

You can set custom headers to be sent with a specific request by using the additionalHeaders property of the options classes (e.g. ClientReadOptions, ClientWriteOptions, etc.).

import com.fasterxml.jackson.databind.ObjectMapper;
import dev.openfga.sdk.api.client.OpenFgaClient;
import dev.openfga.sdk.api.configuration.ClientConfiguration;
import java.net.http.HttpClient;

public class Example {
    public static void main(String[] args) throws Exception {
        var config = new ClientConfiguration()
                .apiUrl(System.getenv("FGA_API_URL"))
                .storeId(System.getenv("FGA_STORE_ID"))
                .authorizationModelId(System.getenv("FGA_MODEL_ID"))
                .defaultHeaders(Map.of(
                        "X-Custom-Header", "default-value",
                        "X-Request-Source", "my-app"
                ));

        var fgaClient = new OpenFgaClient(config);
        var options = new ClientReadOptions()
                    .additionalHeaders(Map.of(
                            "X-Request-Id", "123e4567-e89b-12d3-a456-426614174000",
                            "X-Custom-Header", "overridden-value" // this will override the default value for this request only
                    )
                );
        var response = fgaClient.read(request, options).get();
    }
}

Get your Store ID

You need your store id to call the OpenFGA API (unless it is to call the CreateStore or ListStores methods).

If your server is configured with authentication enabled, you also need to have your credentials ready.

Calling the API

Stores

List Stores

Get a paginated list of stores.

API Documentation

Passing ClientListStoresOptions is optional. All fields of ClientListStoresOptions are optional.

var options = new ClientListStoresOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    .pageSize(10)
    .continuationToken("...");
var stores = fgaClient.listStores(options);

// stores = [{ "id": "01FQH7V8BEG3GPQW93KTRFR8JB", "name": "FGA Demo Store", "created_at": "2022-01-01T00:00:00.000Z", "updated_at": "2022-01-01T00:00:00.000Z" }]

Create Store

Initialize a store.

API Documentation

Passing ClientCreateStoreOptions is optional. All fields of ClientCreateStoreOptions are optional.

var request = new CreateStoreRequest().name("FGA Demo");
var options = new ClientCreateStoreOptions().additionalHeaders(Map.of("Some-Http-Header", "Some value"));
var store = fgaClient.createStore(request, options).get();

// store.getId() = "01FQH7V8BEG3GPQW93KTRFR8JB"

// store the store.getId() in database

// update the storeId of the client instance
fgaClient.setStoreId(store.getId());

// continue calling the API normally

Get Store

Get information about the current store.

API Documentation

Requires a client initialized with a storeId

Passing ClientGetStoreOptions is optional. All fields of ClientGetStoreOptions are optional.

var options = new ClientGetStoreOptions().additionalHeaders(Map.of("Some-Http-Header", "Some value"));
var store = fgaClient.getStore(options).get();

// store = { "id": "01FQH7V8BEG3GPQW93KTRFR8JB", "name": "FGA Demo Store", "created_at": "2022-01-01T00:00:00.000Z", "updated_at": "2022-01-01T00:00:00.000Z" }

Delete Store

Delete a store.

API Documentation

Requires a client initialized with a storeId

Passing ClientDeleteStoreOptions is optional. All fields of ClientDeleteStoreOptions are optional.

var options = new ClientDeleteStoreOptions().additionalHeaders(Map.of("Some-Http-Header", "Some value"));
var store = fgaClient.deleteStore(options).get();

Authorization Models

Read Authorization Models

Read all authorization models in the store.

API Documentation

Passing ClientReadAuthorizationModelsOptions is optional. All fields of ClientReadAuthorizationModelsOptions are optional.

var options = new ClientReadAuthorizationModelsOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    .pageSize(10)
    .continuationToken("...");
var response = fgaClient.readAuthorizationModels(options).get();

// response.getAuthorizationModels() = [
// { id: "01GXSA8YR785C4FYS3C0RTG7B1", schemaVersion: "1.1", typeDefinitions: [...] },
// { id: "01GXSBM5PVYHCJNRNKXMB4QZTW", schemaVersion: "1.1", typeDefinitions: [...] }];

Write Authorization Model

Create a new authorization model.

API Documentation

Note: To learn how to build your authorization model, check the Docs at https://openfga.dev/docs.

Learn more about the OpenFGA configuration language.

You can use the OpenFGA CLI or Syntax Transformer to convert between the OpenFGA DSL and the JSON authorization model.

Passing ClientWriteAuthorizationModelOptions is optional. All fields of ClientWriteAuthorizationModelOptions are optional.

var request = new WriteAuthorizationModelRequest()
    .schemaVersion("1.1")
    .typeDefinitions(List.of(
        new TypeDefinition().type("user").relations(Map.of()),
        new TypeDefinition()
            .type("document")
            .relations(Map.of(
                "writer", new Userset(),
                "viewer", new Userset().union(new Usersets()
                    .child(List.of(
                        new Userset(),
                        new Userset().computedUserset(new ObjectRelation().relation("writer"))
                    ))
                )
            ))
            .metadata(new Metadata()
                .relations(Map.of(
                    "writer", new RelationMetadata().directlyRelatedUserTypes(
                        List.of(new RelationReference().type("user"))
                    ),
                    "viewer", new RelationMetadata().directlyRelatedUserTypes(
                        List.of(new RelationReference().type("user"))
                    )
                ))
            )
    ));
var options = new ClientWriteAuthorizationModelOptions().additionalHeaders(Map.of("Some-Http-Header", "Some value"));

var response = fgaClient.writeAuthorizationModel(request, options).get();

// response.getAuthorizationModelId() = "01GXSA8YR785C4FYS3C0RTG7B1"

Read a Single Authorization Model

Read a particular authorization model.

API Documentation

Passing ClientReadAuthorizationModelOptions is optional. All fields of ClientReadAuthorizationModelOptions are optional.

var options = new ClientReadAuthorizationModelOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    // You can rely on the model id set in the configuration or override it for this specific request
    .authorizationModelId("01GXSA8YR785C4FYS3C0RTG7B1");

var response = fgaClient.readAuthorizationModel(options).get();

// response.getAuthorizationModel().getId() = "01GXSA8YR785C4FYS3C0RTG7B1"
// response.getAuthorizationModel().getSchemaVersion() = "1.1"
// response.getAuthorizationModel().getTypeDefinitions() = [{ "type": "document", "relations": { ... } }, { "type": "user", "relations": { ... }}]

Read the Latest Authorization Model

Reads the latest authorization model (note: this ignores the model id in configuration).

API Documentation

Passing ClientReadLatestAuthorizationModelOptions is optional. All fields of ClientReadLatestAuthorizationModelOptions are optional.

var options = new ClientReadLatestAuthorizationModelOptions().additionalHeaders(Map.of("Some-Http-Header", "Some value"));
var response = fgaClient.readLatestAuthorizationModel(options).get();

// response.getAuthorizationModel().getId() = "01GXSA8YR785C4FYS3C0RTG7B1"
// response.getAuthorizationModel().SchemaVersion() = "1.1"
// response.getAuthorizationModel().TypeDefinitions() = [{ "type": "document", "relations": { ... } }, { "type": "user", "relations": { ... }}]

Relationship Tuples

Read Relationship Tuple Changes (Watch)

Reads the list of historical relationship tuple writes and deletes.

API Documentation

Passing ClientReadChangesOptions is optional. All fields of ClientReadChangesOptions are optional.

var startTime = OffsetDateTime.parse("2022-01-01T00:00:00+00:00");
var request = new ClientReadChangesRequest().type("document").startTime(startTime);
var options = new ClientReadChangesOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    .pageSize(10)
    .continuationToken("...");

var response = fgaClient.readChanges(request, options).get();

// response.getContinuationToken() = ...
// response.getChanges() = [
//   { tupleKey: { user, relation, object }, operation: TupleOperation.WRITE, timestamp: ... },
//   { tupleKey: { user, relation, object }, operation: TupleOperation.DELETE, timestamp: ... }
// ]

Read Relationship Tuples

Reads the relationship tuples stored in the database. It does not evaluate nor exclude invalid tuples according to the authorization model.

API Documentation

Passing ClientReadOptions is optional. All fields of ClientReadOptions are optional.

// Find if a relationship tuple stating that a certain user is a viewer of a certain document
var request = new ClientReadRequest()
    .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
    .relation("viewer")
    ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a");

// Find all relationship tuples where a certain user has a relationship as any relation to a certain document
var request = new ClientReadRequest()
    .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
    ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a");

// Find all relationship tuples where a certain user is a viewer of any document
var request = new ClientReadRequest()
    .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
    .relation("viewer")
    ._object("document:");

// Find all relationship tuples where any user has a relationship as any relation with a particular document
var request = new ClientReadRequest()
    ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a");

// Read all stored relationship tuples
var request = new ClientReadRequest();

var options = new ClientReadOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    .pageSize(10)
    .continuationToken("...");

var response = fgaClient.read(request, options).get();

// In all the above situations, the response will be of the form:
// response = { tuples: [{ key: { user, relation, object }, timestamp }, ...]}

Write (Create and Delete) Relationship Tuples

Create and/or delete relationship tuples to update the system state.

API Documentation

Passing ClientWriteOptions is optional. All fields of ClientWriteOptions are optional.

Transaction mode (default)

By default, write runs in a transaction mode where any invalid operation (deleting a non-existing tuple, creating an existing tuple, one of the tuples was invalid) or a server error will fail the entire operation.

var request = new ClientWriteRequest()
    .writes(List.of(
        new TupleKey()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("viewer")
            ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"),
        new TupleKey()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("viewer")
            ._object("document:0192ab2d-d36e-7cb3-a4a8-5d1d67a300c5")
    ))
    .deletes(List.of(
        new TupleKey()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("writer")
            ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
    ));

var options = new ClientWriteOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    // You can rely on the model id set in the configuration or override it for this specific request
    .authorizationModelId("01GXSA8YR785C4FYS3C0RTG7B1")
    .transactions(true);

var response = fgaClient.write(request, options).get();

Convenience WriteTuples and DeleteTuples methods are also available.

Non-transaction mode

The SDK will split the writes into separate chunks and send them in parallel. Each chunk is sent as its own transaction.

Passing ClientWriteOptions with .transactions(false) is required to use non-transaction mode. All other fields of ClientWriteOptions are optional.

var request = new ClientWriteRequest()
    .writes(List.of(
        new ClientTupleKey()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("viewer")
            ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"),
        new ClientTupleKey()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("viewer")
            ._object("document:0192ab2d-d36e-7cb3-a4a8-5d1d67a300c5")
    ))
    .deletes(List.of(
        new ClientTupleKeyWithoutCondition()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("writer")
            ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
    ));
var options = new ClientWriteOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    // You can rely on the model id set in the configuration or override it for this specific request
    .authorizationModelId("01GXSA8YR785C4FYS3C0RTG7B1")
    .transactions(false)
    .transactionChunkSize(5); // Max tuples per chunk; each chunk is sent as its own transaction

var response = fgaClient.write(request, options).get();

Conflict options for write operations

Write conflict handling can be controlled using the onDuplicate option for writes and the onMissing option for deletes.

Note: this requires OpenFGA v1.10.0 or later.

• onDuplicate: Controls behavior when attempting to create a tuple that already exists

  • WriteRequestWrites.OnDuplicateEnum.ERROR (default): Return an error
  • WriteRequestWrites.OnDuplicateEnum.IGNORE: Skip the duplicate tuple and continue

• onMissing: Controls behavior when attempting to delete a tuple that doesn't exist

  • WriteRequestDeletes.OnMissingEnum.ERROR (default): Return an error
  • WriteRequestDeletes.OnMissingEnum.IGNORE: Skip the missing tuple and continue

Using conflict options with the write() method:

var request = new ClientWriteRequest()
    .writes(List.of(
        new ClientTupleKey()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("viewer")
            ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
    ))
    .deletes(List.of(
        new ClientTupleKeyWithoutCondition()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("writer")
            ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
    ));

var options = new ClientWriteOptions()
    .onDuplicate(WriteRequestWrites.OnDuplicateEnum.IGNORE)
    .onMissing(WriteRequestDeletes.OnMissingEnum.IGNORE);

var response = fgaClient.write(request, options).get();

Using conflict options with the writeTuples() convenience method:

var tuples = List.of(
    new ClientTupleKey()
        .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
        .relation("viewer")
        ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
);

var options = new ClientWriteTuplesOptions()
    .onDuplicate(WriteRequestWrites.OnDuplicateEnum.IGNORE);

var response = fgaClient.writeTuples(tuples, options).get();

Using conflict options with the deleteTuples() convenience method:

var tuples = List.of(
    new ClientTupleKeyWithoutCondition()
        .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
        .relation("writer")
        ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
);

var options = new ClientDeleteTuplesOptions()
    .onMissing(WriteRequestDeletes.OnMissingEnum.IGNORE);

var response = fgaClient.deleteTuples(tuples, options).get();

Relationship Queries

Check

Check if a user has a particular relation with an object.

API Documentation

Passing ClientCheckOptions is optional. All fields of ClientCheckOptions are optional.

var request = new ClientCheckRequest()
    .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
    .relation("writer")
    ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a");
var options = new ClientCheckOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    // You can rely on the model id set in the configuration or override it for this specific request
    .authorizationModelId("01GXSA8YR785C4FYS3C0RTG7B1");

var response = fgaClient.check(request, options).get();
// response.getAllowed() = true

Batch Check

Similar to check, but instead of checking a single user-object relationship, accepts a list of relationships to check. Requires OpenFGA version 1.8.0 or greater.

API Documentation

Note: The order of batchCheck results is not guaranteed to match the order of the checks provided. Use correlationId to pair responses with requests.

Passing ClientBatchCheckOptions is optional. All fields of ClientBatchCheckOptions are optional.

var request = new ClientBatchCheckRequest().checks(
    List.of(
        new ClientBatchCheckItem()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("viewer")
            ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
            .correlationId("cor-1") // optional, one will be generated for you if not provided
            .contextualTuples(List.of(
                new ClientTupleKey()
                    .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
                    .relation("editor")
                    ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
            )),
        new ClientCheckRequest()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("admin")
            ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"),
            .correlationId("cor-2") // optional, one will be generated for you if not provided
            .contextualTuples(List.of(
                new ClientTupleKey()
                    .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
                    .relation("editor")
                    ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
            )),
        new ClientCheckRequest()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("creator")
            ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
            .correlationId("cor-3"), // optional, one will be generated for you if not provided
        new ClientCheckRequest()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("deleter")
            ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
            .correlationId("cor-4") // optional, one will be generated for you if not provided
        )
);

var options = new ClientBatchCheckOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    // You can rely on the model id set in the configuration or override it for this specific request
    .authorizationModelId("01GXSA8YR785C4FYS3C0RTG7B1")
    .maxParallelRequests(5); // Max number of requests to issue in parallel, defaults to 10 
    .maxBatchSize(20); // Max number of batches to split the list of checks into, defaults to 50

var response = fgaClient.batchCheck(request, options).get();

/*
response.getResult() = [{
    allowed: false,
    correlationId: "cor-1",
    request: {
      user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
      relation: "viewer",
      _object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
      correlationId: "cor-1",
      contextualTuples: [{
        user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
        relation: "editor",
        _object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"
      }]
    },
  },
  {
    allowed: false,
    correlationId: "cor-2",
    request: {
      user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
      relation: "admin",
      _object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
      correlationId: "cor-2",
      contextualTuples: [{
        user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
        relation: "editor",
        _object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"
      }]
    }
  },
  {
    allowed: false,
    correlationId: "cor-3",
    request: {
      user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
      relation: "creator",
      _object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
      correlationId: "cor-3",
    },
    error: <FgaError ...>
  },
  {
    allowed: true,
    correlationId: "cor-4",
    request: {
      user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
      relation: "deleter",
      _object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
      correlationId: "cor-4",
    }
  },
]
*/

If you are using an OpenFGA version less than 1.8.0, you can use clientBatchCheck, which calls check in parallel. It will return allowed: false if it encounters an error, and will return the error in the body. If 429s are encountered, the underlying check will retry up to 3 times. For 5xx errors, all requests will retry with delay calculation using Retry-After headers when provided or exponential backoff as fallback.

var request = List.of(
    new ClientBatchCheckItem()
        .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
        .relation("viewer")
        ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
        .contextualTuples(List.of(
            new ClientTupleKey()
                .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
                .relation("editor")
                ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
        )),
    new ClientCheckRequest()
        .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
        .relation("admin")
        ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"),
        .contextualTuples(List.of(
            new ClientTupleKey()
                .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
                .relation("editor")
                ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
        )),
    new ClientCheckRequest()
        .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
        .relation("creator")
        ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"),
    new ClientCheckRequest()
        .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
        .relation("deleter")
        ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
);
var options = new ClientBatchCheckClientOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    // You can rely on the model id set in the configuration or override it for this specific request
    .authorizationModelId("01GXSA8YR785C4FYS3C0RTG7B1")
    .maxParallelRequests(5); // Max number of requests to issue in parallel, defaults to 10

var response = fgaClient.batchCheck(request, options).get();

/*
response.getResponses() = [{
  allowed: false,
  request: {
    user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
    relation: "viewer",
    _object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
    contextualTuples: [{
      user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
      relation: "editor",
      _object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"
    }]
  }
}, {
  allowed: false,
  request: {
    user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
    relation: "admin",
    _object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
    contextualTuples: [{
      user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
      relation: "editor",
      _object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"
    }]
  }
}, {
  allowed: false,
  request: {
    user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
    relation: "creator",
    _object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
  },
  error: <FgaError ...>
}, {
  allowed: true,
  request: {
    user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
    relation: "deleter",
    _object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
  }},
]
*/

Expand

Expands the relationships in userset tree format.

API Documentation

Passing ClientExpandOptions is optional. All fields of ClientExpandOptions are optional.

var request = new ClientExpandRequest()
    .relation("viewer")
    ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a");
var options = new ClientExpandOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    // You can rely on the model id set in the configuration or override it for this specific request
    .authorizationModelId("01GXSA8YR785C4FYS3C0RTG7B1");

var response = fgaClient.expand(request, options).get();

// response.getTree().getRoot() = {"name":"document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a#viewer","leaf":{"users":{"users":["user:81684243-9356-4421-8fbf-a4f8d36aa31b","user:f52a4f7a-054d-47ff-bb6e-3ac81269988f"]}}}

List Objects

List the objects of a particular type a user has access to.

API Documentation

Passing ClientListObjectsOptions is optional. All fields of ClientListObjectsOptions are optional.

var request = new ClientListObjectsRequest()
    .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
    .relation("viewer")
    .type("document")
    .contextualTuples(List.of(
        new ClientTupleKey()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("writer")
            ._object("document:0192ab2d-d36e-7cb3-a4a8-5d1d67a300c5")
    ));
var options = new ClientListObjectsOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    // You can rely on the model id set in the configuration or override it for this specific request
    .authorizationModelId("01GXSA8YR785C4FYS3C0RTG7B1");

var response = fgaClient.listObjects(request, options).get();

// response.getObjects() = ["document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"]

List Relations

List the relations a user has on an object.

Passing ClientListRelationsOptions is optional. All fields of ClientListRelationsOptions are optional.

var request = new ClientListRelationsRequest()
    .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
    ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
    .relations(List.of("can_view", "can_edit", "can_delete", "can_rename"))
    .contextualTuples(List.of(
        new ClientTupleKey()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("editor")
            ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
        )
    );
var options = new ClientListRelationsOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    // When unspecified, defaults to 10
    .maxParallelRequests()
    // You can rely on the model id set in the configuration or override it for this specific request
    .authorizationModelId(DEFAULT_AUTH_MODEL_ID);

var response = fgaClient.listRelations(request, options).get();

// response.getRelations() = ["can_view", "can_edit"]

List Users

List the users who have a certain relation to a particular type.

API Documentation

// Only a single filter is allowed for the time being
var userFilters = new ArrayList<UserTypeFilter>() {
    {
        add(new UserTypeFilter().type("user"));
        // user filters can also be of the form
        // add(new UserTypeFilter().type("team").relation("member"));
    }
};

var request = new ClientListUsersRequest()
    ._object(new FgaObject().type("document").id("roadmap"))
    .relation("can_read")
    .userFilters(userFilters)
    .context(Map.of("view_count", 100))
    .contextualTupleKeys(List.of(
        new ClientTupleKey()
            .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
            .relation("editor")
            ._object("folder:product"),
        new ClientTupleKey()
            .user("folder:product")
            .relation("parent")
            ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
));

var options = new ClientListUsersOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    // You can rely on the model id set in the configuration or override it for this specific request
    .authorizationModelId("01GXSA8YR785C4FYS3C0RTG7B1");

var response = fgaClient.listUsers(request, options).get();

// response.getUsers() = [{object: {type: "user", id: "81684243-9356-4421-8fbf-a4f8d36aa31b"}}, {userset: { type: "user" }}, ...]

Assertions

Read Assertions

Read assertions for a particular authorization model.

API Documentation

Passing ClientReadAssertionsOptions is optional. All fields of ClientReadAssertionsOptions are optional.

var options = new ClientReadAssertionsOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    // You can rely on the model id set in the configuration or override it for this specific request
    .authorizationModelId("01GXSA8YR785C4FYS3C0RTG7B1");
var response = fgaClient.readAssertions(options).get();

Write Assertions

Update the assertions for a particular authorization model.

API Documentation

Passing ClientWriteAssertionsOptions is optional. All fields of ClientWriteAssertionsOptions are optional.

var options = new ClientWriteAssertionsOptions()
    .additionalHeaders(Map.of("Some-Http-Header", "Some value"))
    .authorizationModelId("01GXSA8YR785C4FYS3C0RTG7B1");
var assertions = List.of(
    new ClientAssertion()
        .user("user:81684243-9356-4421-8fbf-a4f8d36aa31b")
        .relation("viewer")
        ._object("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a")
        .expectation(true)
);
fgaClient.writeAssertions(assertions, options).get();

Calling Other Endpoints

The API Executor provides direct HTTP access to OpenFGA endpoints not yet wrapped by the SDK. It maintains the SDK's client configuration including authentication, telemetry, retries, and error handling.

Use cases:

• Calling endpoints not yet supported by the SDK
• Using an SDK version that lacks support for a particular endpoint
• Accessing custom endpoints that extend the OpenFGA API

Initialize the SDK normally and access the API Executor via the fgaClient instance:

// Initialize the client, same as above
ClientConfiguration config = new ClientConfiguration()
    .apiUrl("http://localhost:8080")
    .storeId("01YCP46JKYM8FJCQ37NMBYHE5X");
OpenFgaClient fgaClient = new OpenFgaClient(config);

// Custom new endpoint that doesn't exist in the SDK yet
Map<String, Object> requestBody = Map.of(
    "user", "user:bob",
    "action", "custom_action",
    "resource", "resource:123"
);

// Build the request
ApiExecutorRequestBuilder request = ApiExecutorRequestBuilder.builder("POST", "/stores/{store_id}/custom-endpoint")
    .pathParam("store_id", storeId)
    .queryParam("page_size", "20")
    .queryParam("continuation_token", "eyJwayI6...")
    .body(requestBody)
    .header("X-Experimental-Feature", "enabled")
    .build();

Example: Calling a new "Custom Endpoint" endpoint and handling raw response

// Get raw response without automatic decoding
ApiResponse<String> rawResponse = fgaClient.apiExecutor().send(request).get();

String rawJson = rawResponse.getData();
System.out.println("Response: " + rawJson);

// You can access fields like headers, status code, etc. from rawResponse:
System.out.println("Status Code: " + rawResponse.getStatusCode());
System.out.println("Headers: " + rawResponse.getHeaders());

Example: Calling a new "Custom Endpoint" endpoint and decoding response into a struct

// Define a class to hold the response
class CustomEndpointResponse {
    private boolean allowed;
    private String reason;

    public boolean isAllowed() { return allowed; }
    public void setAllowed(boolean allowed) { this.allowed = allowed; }
    public String getReason() { return reason; }
    public void setReason(String reason) { this.reason = reason; }
}

// Get response decoded into CustomEndpointResponse class
ApiResponse<CustomEndpointResponse> response = fgaClient.apiExecutor()
    .send(request, CustomEndpointResponse.class)
    .get();

CustomEndpointResponse customEndpointResponse = response.getData();
System.out.println("Allowed: " + customEndpointResponse.isAllowed());
System.out.println("Reason: " + customEndpointResponse.getReason());

// You can access fields like headers, status code, etc. from response:
System.out.println("Status Code: " + response.getStatusCode());
System.out.println("Headers: " + response.getHeaders());

Calling a streaming endpoint

For streaming endpoints, use streamingApiExecutor instead. Pass the response class directly — the SDK handles the rest. It delivers each response object to a consumer callback as it arrives, and returns a CompletableFuture<Void> that completes when the stream is exhausted.

ApiExecutorRequestBuilder request = ApiExecutorRequestBuilder.builder(HttpMethod.POST, "/stores/{store_id}/streamed-list-objects")
    .body(new ListObjectsRequest().user("user:anne").relation("viewer").type("document"))
    .build();

fgaClient.streamingApiExecutor(StreamedListObjectsResponse.class)
    .stream(
        request,
        response -> System.out.println("Object: " + response.getObject()),  // called per object
        error    -> System.err.println("Stream error: " + error.getMessage()) // optional
    )
    .thenRun(() -> System.out.println("Streaming complete"))
    .exceptionally(err -> {
        System.err.println("Fatal error: " + err.getMessage());
        return null;
    });

For a complete working example, see examples/api-executor.

Documentation

See docs/ApiExecutor.md for complete API reference and examples for both ApiExecutor and StreamingApiExecutor.

Retries

The SDK implements RFC 9110 compliant retry behavior with support for the Retry-After header. By default, the SDK will automatically retry failed requests up to 3 times with delay calculation (maximum allowable: 15 retries).

Retry Behavior

Rate Limiting (429 errors): Always retried regardless of HTTP method.

Server Errors (5xx): All requests are retried on 5xx errors (except 501 Not Implemented) regardless of HTTP method:

• All operations (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS): Always retried on 5xx errors with delay calculation

Delay Calculation

1. Retry-After header present: Uses the server-specified delay (supports both integer seconds and HTTP-date formats)
2. No Retry-After header: Uses exponential backoff with jitter (base delay: 2^retryCount * 100ms, capped at 120 seconds)
3. Minimum delay: Respects the configured minimumRetryDelay as a floor value

Configuration

Customize retry behavior using the ClientConfiguration builder. The SDK enforces a maximum of 15 retries to prevent accidental server overload:

⚠️ Breaking Changes:

• Configuration validation now prevents setting maxRetries above 15
• FgaError now exposes the Retry-After header value via getRetryAfterHeader()

import com.fasterxml.jackson.databind.ObjectMapper;
import dev.openfga.sdk.api.client.OpenFgaClient;
import dev.openfga.sdk.api.configuration.ClientConfiguration;
import java.net.http.HttpClient;

public class Example {
    public static void main(String[] args) throws Exception {
        var config = new ClientConfiguration()
                .apiUrl(System.getenv("FGA_API_URL")) // If not specified, will default to "http://localhost:8080"
                .storeId(System.getenv("FGA_STORE_ID")) // Not required when calling createStore() or listStores()
                .authorizationModelId(System.getenv("FGA_MODEL_ID")) // Optional, can be overridden per request
                .maxRetries(3) // retry up to 3 times on API requests (default: 3, maximum: 15)
                .minimumRetryDelay(Duration.ofMillis(100)); // minimum wait time between retries in milliseconds (default: 100ms)

        var fgaClient = new OpenFgaClient(config);
        var response = fgaClient.readAuthorizationModels().get();
    }
}

Error Handling with Retry Information

When handling errors, you can access the Retry-After header value for debugging or custom retry logic:

try {
    var response = fgaClient.check(request).get();
} catch (ExecutionException e) {
    if (e.getCause() instanceof FgaError) {
        FgaError error = (FgaError) e.getCause();
        
        // Access Retry-After header if present
        String retryAfter = error.getRetryAfterHeader();
        if (retryAfter != null) {
            System.out.println("Server requested retry after: " + retryAfter + " seconds");
        }
        
        System.out.println("Error: " + error.getMessage());
    }
}

API Endpoints

Method	HTTP request	Description
batchCheck	POST /stores/{store_id}/batch-check	Send a list of `check` operations in a single request
check	POST /stores/{store_id}/check	Check whether a user is authorized to access an object
createStore	POST /stores	Create a store
deleteStore	DELETE /stores/{store_id}	Delete a store
expand	POST /stores/{store_id}/expand	Expand all relationships in userset tree format, and following userset rewrite rules. Useful to reason about and debug a certain relationship
getStore	GET /stores/{store_id}	Get a store
listObjects	POST /stores/{store_id}/list-objects	List all objects of the given type that the user has a relation with
listStores	GET /stores	List all stores
listUsers	POST /stores/{store_id}/list-users	List the users matching the provided filter who have a certain relation to a particular type.
read	POST /stores/{store_id}/read	Get tuples from the store that matches a query, without following userset rewrite rules
readAssertions	GET /stores/{store_id}/assertions/{authorization_model_id}	Read assertions for an authorization model ID
readAuthorizationModel	GET /stores/{store_id}/authorization-models/{id}	Return a particular version of an authorization model
readAuthorizationModels	GET /stores/{store_id}/authorization-models	Return all the authorization models for a particular store
readChanges	GET /stores/{store_id}/changes	Return a list of all the tuple changes
streamedListObjects	POST /stores/{store_id}/streamed-list-objects	Stream all objects of the given type that the user has a relation with
write	POST /stores/{store_id}/write	Add or delete tuples from the store
writeAssertions	PUT /stores/{store_id}/assertions/{authorization_model_id}	Upsert assertions for an authorization model ID
writeAuthorizationModel	POST /stores/{store_id}/authorization-models	Create a new authorization model

Models

• AbortedMessageResponse

• Any

• Assertion

• AssertionTupleKey

• AuthErrorCode

• AuthorizationModel

• BatchCheckItem

• BatchCheckRequest

• BatchCheckResponse

• BatchCheckSingleResult

• CheckError

• CheckRequest

• CheckRequestTupleKey

• CheckResponse

• Computed

• Condition

• ConditionMetadata

• ConditionParamTypeRef

• ConsistencyPreference

• ContextualTupleKeys

• CreateStoreRequest

• CreateStoreResponse

• Difference

• ErrorCode

• ExpandRequest

• ExpandRequestTupleKey

• ExpandResponse

• FgaObject

• ForbiddenResponse

• GetStoreResponse

• InternalErrorCode

• InternalErrorMessageResponse

• Leaf

• ListObjectsRequest

• ListObjectsResponse

• ListStoresResponse

• ListUsersRequest

• ListUsersResponse

• Metadata

• Node

• Nodes

• NotFoundErrorCode

• NullValue

• ObjectRelation

• PathUnknownErrorMessageResponse

• ReadAssertionsResponse

• ReadAuthorizationModelResponse

• ReadAuthorizationModelsResponse

• ReadChangesResponse

• ReadRequest

• ReadRequestTupleKey

• ReadResponse

• RelationMetadata

• RelationReference

• RelationshipCondition

• SourceInfo

• Status

• Store

• StreamResultOfStreamedListObjectsResponse

• StreamedListObjectsResponse

• Tuple

• TupleChange

• TupleKey

• TupleKeyWithoutCondition

• TupleOperation

• TupleToUserset

• TypeDefinition

• TypeName

• TypedWildcard

• UnauthenticatedResponse

• UnprocessableContentErrorCode

• UnprocessableContentMessageResponse

• User

• UserTypeFilter

• Users

• Userset

• UsersetTree

• UsersetTreeDifference

• UsersetTreeTupleToUserset

• UsersetUser

• Usersets

• ValidationErrorMessageResponse

• WriteAssertionsRequest

• WriteAuthorizationModelRequest

• WriteAuthorizationModelResponse

• WriteRequest

• WriteRequestDeletes

• WriteRequestWrites

OpenTelemetry

This SDK supports producing metrics that can be consumed as part of an OpenTelemetry setup. For more information, please see the documentation

Contributing

See CONTRIBUTING for details.

Author

OpenFGA

License

This project is licensed under the Apache-2.0 license. See the LICENSE file for more info.

The code in this repo was auto generated by OpenAPI Generator from a template based on the Java template, licensed under the Apache License 2.0.