OpenFgaApi

November 19, 2025 · View on GitHub

All URIs are relative to http://localhost

Method	HTTP request	Description
batchCheck	POST /stores/{store_id}/batch-check	Send a list of `check` operations in a single request
batchCheckWithHttpInfo	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
checkWithHttpInfo	POST /stores/{store_id}/check	Check whether a user is authorized to access an object
createStore	POST /stores	Create a store
createStoreWithHttpInfo	POST /stores	Create a store
deleteStore	DELETE /stores/{store_id}	Delete a store
deleteStoreWithHttpInfo	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
expandWithHttpInfo	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
getStoreWithHttpInfo	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
listObjectsWithHttpInfo	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
listStoresWithHttpInfo	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.
listUsersWithHttpInfo	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
readWithHttpInfo	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
readAssertionsWithHttpInfo	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
readAuthorizationModelWithHttpInfo	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
readAuthorizationModelsWithHttpInfo	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
readChangesWithHttpInfo	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
streamedListObjectsWithHttpInfo	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
writeWithHttpInfo	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
writeAssertionsWithHttpInfo	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
writeAuthorizationModelWithHttpInfo	POST /stores/{store_id}/authorization-models	Create a new authorization model

batchCheck

CompletableFuture batchCheck(storeId, body)

Send a list of `check` operations in a single request

The `BatchCheck` API functions nearly identically to `Check`, but instead of checking a single user-object relationship BatchCheck accepts a list of relationships to check and returns a map containing `BatchCheckItem` response for each check it received. An associated `correlation_id` is required for each check in the batch. This ID is used to correlate a check to the appropriate response. It is a string consisting of only alphanumeric characters or hyphens with a maximum length of 36 characters. This `correlation_id` is used to map the result of each check to the item which was checked, so it must be unique for each item in the batch. We recommend using a UUID or ULID as the `correlation_id`, but you can use whatever unique identifier you need as long as it matches this regex pattern: `^[\w\d-]{1,36}$` NOTE: The maximum number of checks that can be passed in the `BatchCheck` API is configurable via the OPENFGA_MAX_CHECKS_PER_BATCH_CHECK environment variable. If `BatchCheck` is called using the SDK, the SDK can split the batch check requests for you. For more details on how `Check` functions, see the docs for `/check`. ### Examples #### A BatchCheckRequest ```json { "checks": [ { "tuple_key": { "object": "document:2021-budget" "relation": "reader", "user": "user:anne", }, "contextual_tuples": {...} "context": {} "correlation_id": "01JA8PM3QM7VBPGB8KMPK8SBD5" }, { "tuple_key": { "object": "document:2021-budget" "relation": "reader", "user": "user:bob", }, "contextual_tuples": {...} "context": {} "correlation_id": "01JA8PMM6A90NV5ET0F28CYSZQ" } ] } ``` Below is a possible response to the above request. Note that the result map's keys are the `correlation_id` values from the checked items in the request: ```json { "result": { "01JA8PMM6A90NV5ET0F28CYSZQ": { "allowed": false, "error": {"message": ""} }, "01JA8PM3QM7VBPGB8KMPK8SBD5": { "allowed": true, "error": {"message": ""} } } ```

Example

// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.configuration.Configuration;
import dev.openfga.sdk.api.client.models.*;
import dev.openfga.sdk.api.OpenFgaApi;
import java.util.concurrent.CompletableFuture;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        OpenFgaApi apiInstance = new OpenFgaApi(defaultClient);
        String storeId = "storeId_example"; // String | 
        BatchCheckRequest body = new BatchCheckRequest(); // BatchCheckRequest | 
        try {
            CompletableFuture<BatchCheckResponse> result = apiInstance.batchCheck(storeId, body);
            System.out.println(result.get());
        } catch (ApiException e) {
            System.err.println("Exception when calling OpenFgaApi#batchCheck");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
storeId	String
body	BatchCheckRequest

Return type

CompletableFuture<BatchCheckResponse>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

Status code	Description	Response headers
200	A successful response.	-
400	Request failed due to invalid input.	-
401	Not authenticated.	-
403	Forbidden.	-
404	Request failed due to incorrect path.	-
409	Request was aborted due a transaction conflict.	-
422	Request timed out due to excessive request throttling.	-
500	Request failed due to internal server error.	-

Status code	Description	Response headers
201	A successful response.	-
400	Request failed due to invalid input.	-
401	Not authenticated.	-
403	Forbidden.	-
404	Request failed due to incorrect path.	-
409	Request was aborted due a transaction conflict.	-
422	Request timed out due to excessive request throttling.	-
500	Request failed due to internal server error.	-

Status code	Description	Response headers
204	A successful response.	-
400	Request failed due to invalid input.	-
401	Not authenticated.	-
403	Forbidden.	-
404	Request failed due to incorrect path.	-
409	Request was aborted due a transaction conflict.	-
422	Request timed out due to excessive request throttling.	-
500	Request failed due to internal server error.	-

Name	Type	Description	Notes
pageSize	Integer		[optional]
continuationToken	String		[optional]
name	String	The name parameter instructs the API to only include results that match that name.Multiple results may be returned. Only exact matches will be returned; substring matches and regexes will not be evaluated	[optional]

Name	Type	Description	Notes
storeId	String
type	String		[optional]
pageSize	Integer		[optional]
continuationToken	String		[optional]
startTime	OffsetDateTime	Start date and time of changes to read. Format: ISO 8601 timestamp (e.g., 2022-01-01T00:00:00Z) If a continuation_token is provided along side start_time, the continuation_token will take precedence over start_time.	[optional]

Status code	Description	Response headers
200	A successful response.(streaming responses)	-
400	Request failed due to invalid input.	-
401	Not authenticated.	-
403	Forbidden.	-
404	Request failed due to incorrect path.	-
409	Request was aborted due a transaction conflict.	-
422	Request timed out due to excessive request throttling.	-
500	Request failed due to internal server error.	-

Name	Type	Description	Notes
storeId	String
authorizationModelId	String
body	WriteAssertionsRequest