All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| 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 |
| 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 |
CompletableFuture check(storeId, body)
Check whether a user is authorized to access an object
The Check API returns whether a given user has a relationship with a given object in a given store. The `user` field of the request can be a specific target, such as `user:anne`, or a userset (set of users) such as `group:marketing#member` or a type-bound public access `user:*`. To arrive at a result, the API uses: an authorization model, explicit tuples written through the Write API, contextual tuples present in the request, and implicit tuples that exist by virtue of applying set theory (such as `document:2021-budget#viewer@document:2021-budget#viewer`; the set of users who are viewers of `document:2021-budget` are the set of users who are the viewers of `document:2021-budget`). A `contextual_tuples` object may also be included in the body of the request. This object contains one field `tuple_keys`, which is an array of tuple keys. Each of these tuples may have an associated `condition`. You may also provide an `authorization_model_id` in the body. This will be used to assert that the input `tuple_key` is valid for the model specified. If not specified, the assertion will be made against the latest authorization model ID. It is strongly recommended to specify authorization model id for better performance. You may also provide a `context` object that will be used to evaluate the conditioned tuples in the system. It is strongly recommended to provide a value for all the input parameters of all the conditions, to ensure that all tuples be evaluated correctly. The response will return whether the relationship exists in the field `allowed`. Some exceptions apply, but in general, if a Check API responds with `{allowed: true}`, then you can expect the equivalent ListObjects query to return the object, and viceversa. For example, if `Check(user:anne, reader, document:2021-budget)` responds with `{allowed: true}`, then `ListObjects(user:anne, reader, document)` may include `document:2021-budget` in the response. ## Examples ### Querying with contextual tuples In order to check if user `user:anne` of type `user` has a `reader` relationship with object `document:2021-budget` given the following contextual tuple ```json { "user": "user:anne", "relation": "member", "object": "time_slot:office_hours" } ``` the Check API can be used with the following request body: ```json { "tuple_key": { "user": "user:anne", "relation": "reader", "object": "document:2021-budget" }, "contextual_tuples": { "tuple_keys": [ { "user": "user:anne", "relation": "member", "object": "time_slot:office_hours" } ] }, "authorization_model_id": "01G50QVV17PECNVAHX1GG4Y5NC" } ``` ### Querying usersets Some Checks will always return `true`, even without any tuples. For example, for the following authorization model ```python model schema 1.1 type user type document relations define reader: [user] ``` the following query ```json { "tuple_key": { "user": "document:2021-budget#reader", "relation": "reader", "object": "document:2021-budget" } } ``` will always return `{ "allowed": true }`. This is because usersets are self-defining: the userset `document:2021-budget#reader` will always have the `reader` relation with `document:2021-budget`. ### Querying usersets with difference in the model A Check for a userset can yield results that must be treated carefully if the model involves difference. For example, for the following authorization model ```python model schema 1.1 type user type group relations define member: [user] type document relations define blocked: [user] define reader: [group#member] but not blocked ``` the following query ```json { "tuple_key": { "user": "group:finance#member", "relation": "reader", "object": "document:2021-budget" }, "contextual_tuples": { "tuple_keys": [ { "user": "user:anne", "relation": "member", "object": "group:finance" }, { "user": "group:finance#member", "relation": "reader", "object": "document:2021-budget" }, { "user": "user:anne", "relation": "blocked", "object": "document:2021-budget" } ] }, } ``` will return `{ "allowed": true }`, even though a specific user of the userset `group:finance#member` does not have the `reader` relationship with the given object.
// 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 |
CheckRequest body = new CheckRequest(); // CheckRequest |
try {
CompletableFuture<CheckResponse> result = apiInstance.check(storeId, body);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#check");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| body | CheckRequest |
CompletableFuture<CheckResponse>
No authorization required
- 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. | - |
| 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. | - |
CompletableFuture<ApiResponse> check checkWithHttpInfo(storeId, body)
Check whether a user is authorized to access an object
The Check API returns whether a given user has a relationship with a given object in a given store. The `user` field of the request can be a specific target, such as `user:anne`, or a userset (set of users) such as `group:marketing#member` or a type-bound public access `user:*`. To arrive at a result, the API uses: an authorization model, explicit tuples written through the Write API, contextual tuples present in the request, and implicit tuples that exist by virtue of applying set theory (such as `document:2021-budget#viewer@document:2021-budget#viewer`; the set of users who are viewers of `document:2021-budget` are the set of users who are the viewers of `document:2021-budget`). A `contextual_tuples` object may also be included in the body of the request. This object contains one field `tuple_keys`, which is an array of tuple keys. Each of these tuples may have an associated `condition`. You may also provide an `authorization_model_id` in the body. This will be used to assert that the input `tuple_key` is valid for the model specified. If not specified, the assertion will be made against the latest authorization model ID. It is strongly recommended to specify authorization model id for better performance. You may also provide a `context` object that will be used to evaluate the conditioned tuples in the system. It is strongly recommended to provide a value for all the input parameters of all the conditions, to ensure that all tuples be evaluated correctly. The response will return whether the relationship exists in the field `allowed`. Some exceptions apply, but in general, if a Check API responds with `{allowed: true}`, then you can expect the equivalent ListObjects query to return the object, and viceversa. For example, if `Check(user:anne, reader, document:2021-budget)` responds with `{allowed: true}`, then `ListObjects(user:anne, reader, document)` may include `document:2021-budget` in the response. ## Examples ### Querying with contextual tuples In order to check if user `user:anne` of type `user` has a `reader` relationship with object `document:2021-budget` given the following contextual tuple ```json { "user": "user:anne", "relation": "member", "object": "time_slot:office_hours" } ``` the Check API can be used with the following request body: ```json { "tuple_key": { "user": "user:anne", "relation": "reader", "object": "document:2021-budget" }, "contextual_tuples": { "tuple_keys": [ { "user": "user:anne", "relation": "member", "object": "time_slot:office_hours" } ] }, "authorization_model_id": "01G50QVV17PECNVAHX1GG4Y5NC" } ``` ### Querying usersets Some Checks will always return `true`, even without any tuples. For example, for the following authorization model ```python model schema 1.1 type user type document relations define reader: [user] ``` the following query ```json { "tuple_key": { "user": "document:2021-budget#reader", "relation": "reader", "object": "document:2021-budget" } } ``` will always return `{ "allowed": true }`. This is because usersets are self-defining: the userset `document:2021-budget#reader` will always have the `reader` relation with `document:2021-budget`. ### Querying usersets with difference in the model A Check for a userset can yield results that must be treated carefully if the model involves difference. For example, for the following authorization model ```python model schema 1.1 type user type group relations define member: [user] type document relations define blocked: [user] define reader: [group#member] but not blocked ``` the following query ```json { "tuple_key": { "user": "group:finance#member", "relation": "reader", "object": "document:2021-budget" }, "contextual_tuples": { "tuple_keys": [ { "user": "user:anne", "relation": "member", "object": "group:finance" }, { "user": "group:finance#member", "relation": "reader", "object": "document:2021-budget" }, { "user": "user:anne", "relation": "blocked", "object": "document:2021-budget" } ] }, } ``` will return `{ "allowed": true }`, even though a specific user of the userset `group:finance#member` does not have the `reader` relationship with the given object.
// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.client.ApiResponse;
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 |
CheckRequest body = new CheckRequest(); // CheckRequest |
try {
CompletableFuture<ApiResponse<CheckResponse>> response = apiInstance.checkWithHttpInfo(storeId, body);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OpenFgaApi#check");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#check");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| body | CheckRequest |
CompletableFuture<ApiResponse<CheckResponse>>
No authorization required
- 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. | - |
| 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. | - |
CompletableFuture createStore(body)
Create a store
Create a unique OpenFGA store which will be used to store authorization models and relationship tuples.
// 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);
CreateStoreRequest body = new CreateStoreRequest(); // CreateStoreRequest |
try {
CompletableFuture<CreateStoreResponse> result = apiInstance.createStore(body);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#createStore");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| body | CreateStoreRequest |
CompletableFuture<CreateStoreResponse>
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture<ApiResponse> createStore createStoreWithHttpInfo(body)
Create a store
Create a unique OpenFGA store which will be used to store authorization models and relationship tuples.
// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.client.ApiResponse;
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);
CreateStoreRequest body = new CreateStoreRequest(); // CreateStoreRequest |
try {
CompletableFuture<ApiResponse<CreateStoreResponse>> response = apiInstance.createStoreWithHttpInfo(body);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OpenFgaApi#createStore");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#createStore");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| body | CreateStoreRequest |
CompletableFuture<ApiResponse<CreateStoreResponse>>
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture deleteStore(storeId)
Delete a store
Delete an OpenFGA store. This does not delete the data associated with the store, like tuples or authorization models.
// 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 |
try {
CompletableFuture<Void> result = apiInstance.deleteStore(storeId);
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#deleteStore");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String |
CompletableFuture (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture<ApiResponse> deleteStore deleteStoreWithHttpInfo(storeId)
Delete a store
Delete an OpenFGA store. This does not delete the data associated with the store, like tuples or authorization models.
// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.client.ApiResponse;
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 |
try {
CompletableFuture<ApiResponse<Void>> response = apiInstance.deleteStoreWithHttpInfo(storeId);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OpenFgaApi#deleteStore");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#deleteStore");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String |
CompletableFuture<ApiResponse>
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 204 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture expand(storeId, body)
Expand all relationships in userset tree format, and following userset rewrite rules. Useful to reason about and debug a certain relationship
The Expand API will return all users and usersets that have certain relationship with an object in a certain store. This is different from the `/stores/{store_id}/read` API in that both users and computed usersets are returned. Body parameters `tuple_key.object` and `tuple_key.relation` are all required. The response will return a tree whose leaves are the specific users and usersets. Union, intersection and difference operator are located in the intermediate nodes. ## Example To expand all users that have the `reader` relationship with object `document:2021-budget`, use the Expand API with the following request body ```json { "tuple_key": { "object": "document:2021-budget", "relation": "reader" }, "authorization_model_id": "01G50QVV17PECNVAHX1GG4Y5NC" } ``` OpenFGA's response will be a userset tree of the users and usersets that have read access to the document. ```json { "tree":{ "root":{ "type":"document:2021-budget#reader", "union":{ "nodes":[ { "type":"document:2021-budget#reader", "leaf":{ "users":{ "users":[ "user:bob" ] } } }, { "type":"document:2021-budget#reader", "leaf":{ "computed":{ "userset":"document:2021-budget#writer" } } } ] } } } } ``` The caller can then call expand API for the `writer` relationship for the `document:2021-budget`.
// 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 |
ExpandRequest body = new ExpandRequest(); // ExpandRequest |
try {
CompletableFuture<ExpandResponse> result = apiInstance.expand(storeId, body);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#expand");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| body | ExpandRequest |
CompletableFuture<ExpandResponse>
No authorization required
- 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. | - |
| 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. | - |
CompletableFuture<ApiResponse> expand expandWithHttpInfo(storeId, body)
Expand all relationships in userset tree format, and following userset rewrite rules. Useful to reason about and debug a certain relationship
The Expand API will return all users and usersets that have certain relationship with an object in a certain store. This is different from the `/stores/{store_id}/read` API in that both users and computed usersets are returned. Body parameters `tuple_key.object` and `tuple_key.relation` are all required. The response will return a tree whose leaves are the specific users and usersets. Union, intersection and difference operator are located in the intermediate nodes. ## Example To expand all users that have the `reader` relationship with object `document:2021-budget`, use the Expand API with the following request body ```json { "tuple_key": { "object": "document:2021-budget", "relation": "reader" }, "authorization_model_id": "01G50QVV17PECNVAHX1GG4Y5NC" } ``` OpenFGA's response will be a userset tree of the users and usersets that have read access to the document. ```json { "tree":{ "root":{ "type":"document:2021-budget#reader", "union":{ "nodes":[ { "type":"document:2021-budget#reader", "leaf":{ "users":{ "users":[ "user:bob" ] } } }, { "type":"document:2021-budget#reader", "leaf":{ "computed":{ "userset":"document:2021-budget#writer" } } } ] } } } } ``` The caller can then call expand API for the `writer` relationship for the `document:2021-budget`.
// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.client.ApiResponse;
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 |
ExpandRequest body = new ExpandRequest(); // ExpandRequest |
try {
CompletableFuture<ApiResponse<ExpandResponse>> response = apiInstance.expandWithHttpInfo(storeId, body);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OpenFgaApi#expand");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#expand");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| body | ExpandRequest |
CompletableFuture<ApiResponse<ExpandResponse>>
No authorization required
- 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. | - |
| 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. | - |
CompletableFuture getStore(storeId)
Get a store
Returns an OpenFGA store by its identifier
// 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 |
try {
CompletableFuture<GetStoreResponse> result = apiInstance.getStore(storeId);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#getStore");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String |
CompletableFuture<GetStoreResponse>
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture<ApiResponse> getStore getStoreWithHttpInfo(storeId)
Get a store
Returns an OpenFGA store by its identifier
// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.client.ApiResponse;
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 |
try {
CompletableFuture<ApiResponse<GetStoreResponse>> response = apiInstance.getStoreWithHttpInfo(storeId);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OpenFgaApi#getStore");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#getStore");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String |
CompletableFuture<ApiResponse<GetStoreResponse>>
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture listObjects(storeId, body)
List all objects of the given type that the user has a relation with
The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To arrive at a result, the API uses: an authorization model, explicit tuples written through the Write API, contextual tuples present in the request, and implicit tuples that exist by virtue of applying set theory (such as `document:2021-budget#viewer@document:2021-budget#viewer`; the set of users who are viewers of `document:2021-budget` are the set of users who are the viewers of `document:2021-budget`). An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. Each of these tuples may have an associated `condition`. You may also provide a `context` object that will be used to evaluate the conditioned tuples in the system. It is strongly recommended to provide a value for all the input parameters of all the conditions, to ensure that all tuples be evaluated correctly. The response will contain the related objects in an array in the "objects" field of the response and they will be strings in the object format `<type>:<id>` (e.g. "document:roadmap"). The number of objects in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_OBJECTS_DEADLINE and by the upper bound specified in the flag OPENFGA_LIST_OBJECTS_MAX_RESULTS, whichever is hit first. The objects given will not be sorted, and therefore two identical calls can give a given different set of objects.
// 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 |
ListObjectsRequest body = new ListObjectsRequest(); // ListObjectsRequest |
try {
CompletableFuture<ListObjectsResponse> result = apiInstance.listObjects(storeId, body);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#listObjects");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| body | ListObjectsRequest |
CompletableFuture<ListObjectsResponse>
No authorization required
- 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. | - |
| 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. | - |
CompletableFuture<ApiResponse> listObjects listObjectsWithHttpInfo(storeId, body)
List all objects of the given type that the user has a relation with
The ListObjects API returns a list of all the objects of the given type that the user has a relation with. To arrive at a result, the API uses: an authorization model, explicit tuples written through the Write API, contextual tuples present in the request, and implicit tuples that exist by virtue of applying set theory (such as `document:2021-budget#viewer@document:2021-budget#viewer`; the set of users who are viewers of `document:2021-budget` are the set of users who are the viewers of `document:2021-budget`). An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. Each of these tuples may have an associated `condition`. You may also provide a `context` object that will be used to evaluate the conditioned tuples in the system. It is strongly recommended to provide a value for all the input parameters of all the conditions, to ensure that all tuples be evaluated correctly. The response will contain the related objects in an array in the "objects" field of the response and they will be strings in the object format `<type>:<id>` (e.g. "document:roadmap"). The number of objects in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_OBJECTS_DEADLINE and by the upper bound specified in the flag OPENFGA_LIST_OBJECTS_MAX_RESULTS, whichever is hit first. The objects given will not be sorted, and therefore two identical calls can give a given different set of objects.
// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.client.ApiResponse;
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 |
ListObjectsRequest body = new ListObjectsRequest(); // ListObjectsRequest |
try {
CompletableFuture<ApiResponse<ListObjectsResponse>> response = apiInstance.listObjectsWithHttpInfo(storeId, body);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OpenFgaApi#listObjects");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#listObjects");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| body | ListObjectsRequest |
CompletableFuture<ApiResponse<ListObjectsResponse>>
No authorization required
- 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. | - |
| 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. | - |
CompletableFuture listStores(pageSize, continuationToken)
List all stores
Returns a paginated list of OpenFGA stores and a continuation token to get additional stores. The continuation token will be empty if there are no more stores.
// 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);
Integer pageSize = 56; // Integer |
String continuationToken = "continuationToken_example"; // String |
try {
CompletableFuture<ListStoresResponse> result = apiInstance.listStores(pageSize, continuationToken);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#listStores");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pageSize | Integer | [optional] | |
| continuationToken | String | [optional] |
CompletableFuture<ListStoresResponse>
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture<ApiResponse> listStores listStoresWithHttpInfo(pageSize, continuationToken)
List all stores
Returns a paginated list of OpenFGA stores and a continuation token to get additional stores. The continuation token will be empty if there are no more stores.
// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.client.ApiResponse;
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);
Integer pageSize = 56; // Integer |
String continuationToken = "continuationToken_example"; // String |
try {
CompletableFuture<ApiResponse<ListStoresResponse>> response = apiInstance.listStoresWithHttpInfo(pageSize, continuationToken);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OpenFgaApi#listStores");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#listStores");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pageSize | Integer | [optional] | |
| continuationToken | String | [optional] |
CompletableFuture<ApiResponse<ListStoresResponse>>
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture listUsers(storeId, body)
List the users matching the provided filter who have a certain relation to a particular type.
The ListUsers API returns a list of all the users of a specific type that have a relation to a given object. To arrive at a result, the API uses: an authorization model, explicit tuples written through the Write API, contextual tuples present in the request, and implicit tuples that exist by virtue of applying set theory (such as `document:2021-budget#viewer@document:2021-budget#viewer`; the set of users who are viewers of `document:2021-budget` are the set of users who are the viewers of `document:2021-budget`). An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. Each of these tuples may have an associated `condition`. You may also provide a `context` object that will be used to evaluate the conditioned tuples in the system. It is strongly recommended to provide a value for all the input parameters of all the conditions, to ensure that all tuples be evaluated correctly. The response will contain the related users in an array in the "users" field of the response. These results may include specific objects, usersets or type-bound public access. Each of these types of results is encoded in its own type and not represented as a string.In cases where a type-bound public acces result is returned (e.g. `user:*`), it cannot be inferred that all subjects of that type have a relation to the object; it is possible that negations exist and checks should still be queried on individual subjects to ensure access to that document.The number of users in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_USERS_DEADLINE and by the upper bound specified in the flag OPENFGA_LIST_USERS_MAX_RESULTS, whichever is hit first. The returned users will not be sorted, and therefore two identical calls may yield different sets of users.
// 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 |
ListUsersRequest body = new ListUsersRequest(); // ListUsersRequest |
try {
CompletableFuture<ListUsersResponse> result = apiInstance.listUsers(storeId, body);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#listUsers");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| body | ListUsersRequest |
CompletableFuture<ListUsersResponse>
No authorization required
- 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. | - |
| 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. | - |
CompletableFuture<ApiResponse> listUsers listUsersWithHttpInfo(storeId, body)
List the users matching the provided filter who have a certain relation to a particular type.
The ListUsers API returns a list of all the users of a specific type that have a relation to a given object. To arrive at a result, the API uses: an authorization model, explicit tuples written through the Write API, contextual tuples present in the request, and implicit tuples that exist by virtue of applying set theory (such as `document:2021-budget#viewer@document:2021-budget#viewer`; the set of users who are viewers of `document:2021-budget` are the set of users who are the viewers of `document:2021-budget`). An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. Each of these tuples may have an associated `condition`. You may also provide a `context` object that will be used to evaluate the conditioned tuples in the system. It is strongly recommended to provide a value for all the input parameters of all the conditions, to ensure that all tuples be evaluated correctly. The response will contain the related users in an array in the "users" field of the response. These results may include specific objects, usersets or type-bound public access. Each of these types of results is encoded in its own type and not represented as a string.In cases where a type-bound public acces result is returned (e.g. `user:*`), it cannot be inferred that all subjects of that type have a relation to the object; it is possible that negations exist and checks should still be queried on individual subjects to ensure access to that document.The number of users in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_USERS_DEADLINE and by the upper bound specified in the flag OPENFGA_LIST_USERS_MAX_RESULTS, whichever is hit first. The returned users will not be sorted, and therefore two identical calls may yield different sets of users.
// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.client.ApiResponse;
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 |
ListUsersRequest body = new ListUsersRequest(); // ListUsersRequest |
try {
CompletableFuture<ApiResponse<ListUsersResponse>> response = apiInstance.listUsersWithHttpInfo(storeId, body);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OpenFgaApi#listUsers");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#listUsers");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| body | ListUsersRequest |
CompletableFuture<ApiResponse<ListUsersResponse>>
No authorization required
- 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. | - |
| 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. | - |
CompletableFuture read(storeId, body)
Get tuples from the store that matches a query, without following userset rewrite rules
The Read API will return the tuples for a certain store that match a query filter specified in the body of the request. The API doesn't guarantee order by any field. It is different from the `/stores/{store_id}/expand` API in that it only returns relationship tuples that are stored in the system and satisfy the query. In the body: 1. `tuple_key` is optional. If not specified, it will return all tuples in the store. 2. `tuple_key.object` is mandatory if `tuple_key` is specified. It can be a full object (e.g., `type:object_id`) or type only (e.g., `type:`). 3. `tuple_key.user` is mandatory if tuple_key is specified in the case the `tuple_key.object` is a type only. ## Examples ### Query for all objects in a type definition To query for all objects that `user:bob` has `reader` relationship in the `document` type definition, call read API with body of ```json { "tuple_key": { "user": "user:bob", "relation": "reader", "object": "document:" } } ``` The API will return tuples and a continuation token, something like ```json { "tuples": [ { "key": { "user": "user:bob", "relation": "reader", "object": "document:2021-budget" }, "timestamp": "2021-10-06T15:32:11.128Z" } ], "continuation_token": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==" } ``` This means that `user:bob` has a `reader` relationship with 1 document `document:2021-budget`. Note that this API, unlike the List Objects API, does not evaluate the tuples in the store. The continuation token will be empty if there are no more tuples to query. ### Query for all stored relationship tuples that have a particular relation and object To query for all users that have `reader` relationship with `document:2021-budget`, call read API with body of ```json { "tuple_key": { "object": "document:2021-budget", "relation": "reader" } } ``` The API will return something like ```json { "tuples": [ { "key": { "user": "user:bob", "relation": "reader", "object": "document:2021-budget" }, "timestamp": "2021-10-06T15:32:11.128Z" } ], "continuation_token": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==" } ``` This means that `document:2021-budget` has 1 `reader` (`user:bob`). Note that, even if the model said that all `writers` are also `readers`, the API will not return writers such as `user:anne` because it only returns tuples and does not evaluate them. ### Query for all users with all relationships for a particular document To query for all users that have any relationship with `document:2021-budget`, call read API with body of ```json { "tuple_key": { "object": "document:2021-budget" } } ``` The API will return something like ```json { "tuples": [ { "key": { "user": "user:anne", "relation": "writer", "object": "document:2021-budget" }, "timestamp": "2021-10-05T13:42:12.356Z" }, { "key": { "user": "user:bob", "relation": "reader", "object": "document:2021-budget" }, "timestamp": "2021-10-06T15:32:11.128Z" } ], "continuation_token": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==" } ``` This means that `document:2021-budget` has 1 `reader` (`user:bob`) and 1 `writer` (`user:anne`).
// 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 |
ReadRequest body = new ReadRequest(); // ReadRequest |
try {
CompletableFuture<ReadResponse> result = apiInstance.read(storeId, body);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#read");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| body | ReadRequest |
CompletableFuture<ReadResponse>
No authorization required
- 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. | - |
| 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. | - |
CompletableFuture<ApiResponse> read readWithHttpInfo(storeId, body)
Get tuples from the store that matches a query, without following userset rewrite rules
The Read API will return the tuples for a certain store that match a query filter specified in the body of the request. The API doesn't guarantee order by any field. It is different from the `/stores/{store_id}/expand` API in that it only returns relationship tuples that are stored in the system and satisfy the query. In the body: 1. `tuple_key` is optional. If not specified, it will return all tuples in the store. 2. `tuple_key.object` is mandatory if `tuple_key` is specified. It can be a full object (e.g., `type:object_id`) or type only (e.g., `type:`). 3. `tuple_key.user` is mandatory if tuple_key is specified in the case the `tuple_key.object` is a type only. ## Examples ### Query for all objects in a type definition To query for all objects that `user:bob` has `reader` relationship in the `document` type definition, call read API with body of ```json { "tuple_key": { "user": "user:bob", "relation": "reader", "object": "document:" } } ``` The API will return tuples and a continuation token, something like ```json { "tuples": [ { "key": { "user": "user:bob", "relation": "reader", "object": "document:2021-budget" }, "timestamp": "2021-10-06T15:32:11.128Z" } ], "continuation_token": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==" } ``` This means that `user:bob` has a `reader` relationship with 1 document `document:2021-budget`. Note that this API, unlike the List Objects API, does not evaluate the tuples in the store. The continuation token will be empty if there are no more tuples to query. ### Query for all stored relationship tuples that have a particular relation and object To query for all users that have `reader` relationship with `document:2021-budget`, call read API with body of ```json { "tuple_key": { "object": "document:2021-budget", "relation": "reader" } } ``` The API will return something like ```json { "tuples": [ { "key": { "user": "user:bob", "relation": "reader", "object": "document:2021-budget" }, "timestamp": "2021-10-06T15:32:11.128Z" } ], "continuation_token": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==" } ``` This means that `document:2021-budget` has 1 `reader` (`user:bob`). Note that, even if the model said that all `writers` are also `readers`, the API will not return writers such as `user:anne` because it only returns tuples and does not evaluate them. ### Query for all users with all relationships for a particular document To query for all users that have any relationship with `document:2021-budget`, call read API with body of ```json { "tuple_key": { "object": "document:2021-budget" } } ``` The API will return something like ```json { "tuples": [ { "key": { "user": "user:anne", "relation": "writer", "object": "document:2021-budget" }, "timestamp": "2021-10-05T13:42:12.356Z" }, { "key": { "user": "user:bob", "relation": "reader", "object": "document:2021-budget" }, "timestamp": "2021-10-06T15:32:11.128Z" } ], "continuation_token": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==" } ``` This means that `document:2021-budget` has 1 `reader` (`user:bob`) and 1 `writer` (`user:anne`).
// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.client.ApiResponse;
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 |
ReadRequest body = new ReadRequest(); // ReadRequest |
try {
CompletableFuture<ApiResponse<ReadResponse>> response = apiInstance.readWithHttpInfo(storeId, body);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OpenFgaApi#read");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#read");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| body | ReadRequest |
CompletableFuture<ApiResponse<ReadResponse>>
No authorization required
- 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. | - |
| 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. | - |
CompletableFuture readAssertions(storeId, authorizationModelId)
Read assertions for an authorization model ID
The ReadAssertions API will return, for a given authorization model id, all the assertions stored for it. An assertion is an object that contains a tuple key, and the expectation of whether a call to the Check API of that tuple key will return true or false.
// 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 |
String authorizationModelId = "authorizationModelId_example"; // String |
try {
CompletableFuture<ReadAssertionsResponse> result = apiInstance.readAssertions(storeId, authorizationModelId);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#readAssertions");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| authorizationModelId | String |
CompletableFuture<ReadAssertionsResponse>
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture<ApiResponse> readAssertions readAssertionsWithHttpInfo(storeId, authorizationModelId)
Read assertions for an authorization model ID
The ReadAssertions API will return, for a given authorization model id, all the assertions stored for it. An assertion is an object that contains a tuple key, and the expectation of whether a call to the Check API of that tuple key will return true or false.
// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.client.ApiResponse;
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 |
String authorizationModelId = "authorizationModelId_example"; // String |
try {
CompletableFuture<ApiResponse<ReadAssertionsResponse>> response = apiInstance.readAssertionsWithHttpInfo(storeId, authorizationModelId);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OpenFgaApi#readAssertions");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#readAssertions");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| authorizationModelId | String |
CompletableFuture<ApiResponse<ReadAssertionsResponse>>
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture readAuthorizationModel(storeId, id)
Return a particular version of an authorization model
The ReadAuthorizationModel API returns an authorization model by its identifier. The response will return the authorization model for the particular version. ## Example To retrieve the authorization model with ID `01G5JAVJ41T49E9TT3SKVS7X1J` for the store, call the GET authorization-models by ID API with `01G5JAVJ41T49E9TT3SKVS7X1J` as the `id` path parameter. The API will return: ```json { "authorization_model":{ "id":"01G5JAVJ41T49E9TT3SKVS7X1J", "type_definitions":[ { "type":"user" }, { "type":"document", "relations":{ "reader":{ "union":{ "child":[ { "this":{} }, { "computedUserset":{ "object":"", "relation":"writer" } } ] } }, "writer":{ "this":{} } } } ] } } ``` In the above example, there are 2 types (`user` and `document`). The `document` type has 2 relations (`writer` and `reader`).
// 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 |
String id = "id_example"; // String |
try {
CompletableFuture<ReadAuthorizationModelResponse> result = apiInstance.readAuthorizationModel(storeId, id);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#readAuthorizationModel");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| id | String |
CompletableFuture<ReadAuthorizationModelResponse>
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture<ApiResponse> readAuthorizationModel readAuthorizationModelWithHttpInfo(storeId, id)
Return a particular version of an authorization model
The ReadAuthorizationModel API returns an authorization model by its identifier. The response will return the authorization model for the particular version. ## Example To retrieve the authorization model with ID `01G5JAVJ41T49E9TT3SKVS7X1J` for the store, call the GET authorization-models by ID API with `01G5JAVJ41T49E9TT3SKVS7X1J` as the `id` path parameter. The API will return: ```json { "authorization_model":{ "id":"01G5JAVJ41T49E9TT3SKVS7X1J", "type_definitions":[ { "type":"user" }, { "type":"document", "relations":{ "reader":{ "union":{ "child":[ { "this":{} }, { "computedUserset":{ "object":"", "relation":"writer" } } ] } }, "writer":{ "this":{} } } } ] } } ``` In the above example, there are 2 types (`user` and `document`). The `document` type has 2 relations (`writer` and `reader`).
// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.client.ApiResponse;
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 |
String id = "id_example"; // String |
try {
CompletableFuture<ApiResponse<ReadAuthorizationModelResponse>> response = apiInstance.readAuthorizationModelWithHttpInfo(storeId, id);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OpenFgaApi#readAuthorizationModel");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#readAuthorizationModel");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| id | String |
CompletableFuture<ApiResponse<ReadAuthorizationModelResponse>>
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture readAuthorizationModels(storeId, pageSize, continuationToken)
Return all the authorization models for a particular store
The ReadAuthorizationModels API will return all the authorization models for a certain store. OpenFGA's response will contain an array of all authorization models, sorted in descending order of creation. ## Example Assume that a store's authorization model has been configured twice. To get all the authorization models that have been created in this store, call GET authorization-models. The API will return a response that looks like: ```json { "authorization_models": [ { "id": "01G50QVV17PECNVAHX1GG4Y5NC", "type_definitions": [...] }, { "id": "01G4ZW8F4A07AKQ8RHSVG9RW04", "type_definitions": [...] }, ], "continuation_token": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==" } ``` If there are no more authorization models available, the `continuation_token` field will be empty ```json { "authorization_models": [ { "id": "01G50QVV17PECNVAHX1GG4Y5NC", "type_definitions": [...] }, { "id": "01G4ZW8F4A07AKQ8RHSVG9RW04", "type_definitions": [...] }, ], "continuation_token": "" } ```
// 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 |
Integer pageSize = 56; // Integer |
String continuationToken = "continuationToken_example"; // String |
try {
CompletableFuture<ReadAuthorizationModelsResponse> result = apiInstance.readAuthorizationModels(storeId, pageSize, continuationToken);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#readAuthorizationModels");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| pageSize | Integer | [optional] | |
| continuationToken | String | [optional] |
CompletableFuture<ReadAuthorizationModelsResponse>
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture<ApiResponse> readAuthorizationModels readAuthorizationModelsWithHttpInfo(storeId, pageSize, continuationToken)
Return all the authorization models for a particular store
The ReadAuthorizationModels API will return all the authorization models for a certain store. OpenFGA's response will contain an array of all authorization models, sorted in descending order of creation. ## Example Assume that a store's authorization model has been configured twice. To get all the authorization models that have been created in this store, call GET authorization-models. The API will return a response that looks like: ```json { "authorization_models": [ { "id": "01G50QVV17PECNVAHX1GG4Y5NC", "type_definitions": [...] }, { "id": "01G4ZW8F4A07AKQ8RHSVG9RW04", "type_definitions": [...] }, ], "continuation_token": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==" } ``` If there are no more authorization models available, the `continuation_token` field will be empty ```json { "authorization_models": [ { "id": "01G50QVV17PECNVAHX1GG4Y5NC", "type_definitions": [...] }, { "id": "01G4ZW8F4A07AKQ8RHSVG9RW04", "type_definitions": [...] }, ], "continuation_token": "" } ```
// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.client.ApiResponse;
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 |
Integer pageSize = 56; // Integer |
String continuationToken = "continuationToken_example"; // String |
try {
CompletableFuture<ApiResponse<ReadAuthorizationModelsResponse>> response = apiInstance.readAuthorizationModelsWithHttpInfo(storeId, pageSize, continuationToken);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OpenFgaApi#readAuthorizationModels");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#readAuthorizationModels");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| pageSize | Integer | [optional] | |
| continuationToken | String | [optional] |
CompletableFuture<ApiResponse<ReadAuthorizationModelsResponse>>
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture readChanges(storeId, type, pageSize, continuationToken)
Return a list of all the tuple changes
The ReadChanges API will return a paginated list of tuple changes (additions and deletions) that occurred in a given store, sorted by ascending time. The response will include a continuation token that is used to get the next set of changes. If there are no changes after the provided continuation token, the same token will be returned in order for it to be used when new changes are recorded. If the store never had any tuples added or removed, this token will be empty. You can use the `type` parameter to only get the list of tuple changes that affect objects of that type. When reading a write tuple change, if it was conditioned, the condition will be returned. When reading a delete tuple change, the condition will NOT be returned regardless of whether it was originally conditioned or not.
// 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 |
String type = "type_example"; // String |
Integer pageSize = 56; // Integer |
String continuationToken = "continuationToken_example"; // String |
try {
CompletableFuture<ReadChangesResponse> result = apiInstance.readChanges(storeId, type, pageSize, continuationToken);
System.out.println(result.get());
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#readChanges");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| type | String | [optional] | |
| pageSize | Integer | [optional] | |
| continuationToken | String | [optional] |
CompletableFuture<ReadChangesResponse>
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture<ApiResponse> readChanges readChangesWithHttpInfo(storeId, type, pageSize, continuationToken)
Return a list of all the tuple changes
The ReadChanges API will return a paginated list of tuple changes (additions and deletions) that occurred in a given store, sorted by ascending time. The response will include a continuation token that is used to get the next set of changes. If there are no changes after the provided continuation token, the same token will be returned in order for it to be used when new changes are recorded. If the store never had any tuples added or removed, this token will be empty. You can use the `type` parameter to only get the list of tuple changes that affect objects of that type. When reading a write tuple change, if it was conditioned, the condition will be returned. When reading a delete tuple change, the condition will NOT be returned regardless of whether it was originally conditioned or not.
// Import classes:
import dev.openfga.sdk.api.client.ApiClient;
import dev.openfga.sdk.api.client.ApiException;
import dev.openfga.sdk.api.client.ApiResponse;
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 |
String type = "type_example"; // String |
Integer pageSize = 56; // Integer |
String continuationToken = "continuationToken_example"; // String |
try {
CompletableFuture<ApiResponse<ReadChangesResponse>> response = apiInstance.readChangesWithHttpInfo(storeId, type, pageSize, continuationToken);
System.out.println("Status code: " + response.get().getStatusCode());
System.out.println("Response headers: " + response.get().getHeaders());
System.out.println("Response body: " + response.get().getData());
} catch (InterruptedException | ExecutionException e) {
ApiException apiException = (ApiException)e.getCause();
System.err.println("Exception when calling OpenFgaApi#readChanges");
System.err.println("Status code: " + apiException.getCode());
System.err.println("Response headers: " + apiException.getResponseHeaders());
System.err.println("Reason: " + apiException.getResponseBody());
e.printStackTrace();
} catch (ApiException e) {
System.err.println("Exception when calling OpenFgaApi#readChanges");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| storeId | String | ||
| type | String | [optional] | |
| pageSize | Integer | [optional] | |
| continuationToken | String | [optional] |
CompletableFuture<ApiResponse<ReadChangesResponse>>
No authorization required
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 400 | Request failed due to invalid input. | - |
| 401 | Not authenticated. | - |
| 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. | - |
CompletableFuture write(storeId, body)
Add or delete tuples from the store
The Write API will transactionally update the tuples for a certain store. Tuples and type definitions allow OpenFGA to determine whether a relationship exists between an object and an user. In the body, `writes` adds new tuples and `deletes` removes existing tuples. When deleting a tuple, any `condition` specified with it is ignored. The API is not idempotent: if, later on, you try to add the same tuple key (even if the `condition` is different), or if you try to delete a non-existing tuple, it will throw an error. The API will not allow you to write tuples such as `document:2021-budget#viewer@document:2021-budget#viewer`, because they are implicit. An `authorization_model_id` may be specified in the body. If it is, it will be used to assert that each written tuple (not deleted) is valid for the model specified. If it is not specified, the latest authorization model ID will be used. ## Example ### Adding relationships To add `user:anne` as a `writer` for `document:2021-budget`, call write API with the following ```json { "writes": { "tuple_keys": [ { "user": "user:anne", "relation": "writer", "object": "document:2021-budget" } ] }, "authorization_model_id": "01G50QVV17PECNVAHX1GG4Y5NC" } ``` ### Removing relationships To remove `user:bob` as a `reader` for `document:2021-budget`, call write API with the following ```json { "deletes": { "tuple_keys": [ { "user": "user:bob", "relation": "reader", "object": "document:2021-budget" } ] } } ```
// 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 | WriteRequest body = new WriteRequest(); // WriteRequest | try { CompletableFuture<Object> result = apiInstance.write(storeId, body); System.out.println(result.get()); } catch (ApiException e) { System.err.println("Exception when calling OpenFgaApi#write"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } }
Name Type Description Notes storeId String body WriteRequest CompletableFuture<Object>
No authorization required
- 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. - 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. - CompletableFuture<ApiResponse> write writeWithHttpInfo(storeId, body)
Add or delete tuples from the store
The Write API will transactionally update the tuples for a certain store. Tuples and type definitions allow OpenFGA to determine whether a relationship exists between an object and an user. In the body, `writes` adds new tuples and `deletes` removes existing tuples. When deleting a tuple, any `condition` specified with it is ignored. The API is not idempotent: if, later on, you try to add the same tuple key (even if the `condition` is different), or if you try to delete a non-existing tuple, it will throw an error. The API will not allow you to write tuples such as `document:2021-budget#viewer@document:2021-budget#viewer`, because they are implicit. An `authorization_model_id` may be specified in the body. If it is, it will be used to assert that each written tuple (not deleted) is valid for the model specified. If it is not specified, the latest authorization model ID will be used. ## Example ### Adding relationships To add `user:anne` as a `writer` for `document:2021-budget`, call write API with the following ```json { "writes": { "tuple_keys": [ { "user": "user:anne", "relation": "writer", "object": "document:2021-budget" } ] }, "authorization_model_id": "01G50QVV17PECNVAHX1GG4Y5NC" } ``` ### Removing relationships To remove `user:bob` as a `reader` for `document:2021-budget`, call write API with the following ```json { "deletes": { "tuple_keys": [ { "user": "user:bob", "relation": "reader", "object": "document:2021-budget" } ] } } ```
// Import classes: import dev.openfga.sdk.api.client.ApiClient; import dev.openfga.sdk.api.client.ApiException; import dev.openfga.sdk.api.client.ApiResponse; 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 | WriteRequest body = new WriteRequest(); // WriteRequest | try { CompletableFuture<ApiResponse<Object>> response = apiInstance.writeWithHttpInfo(storeId, body); System.out.println("Status code: " + response.get().getStatusCode()); System.out.println("Response headers: " + response.get().getHeaders()); System.out.println("Response body: " + response.get().getData()); } catch (InterruptedException | ExecutionException e) { ApiException apiException = (ApiException)e.getCause(); System.err.println("Exception when calling OpenFgaApi#write"); System.err.println("Status code: " + apiException.getCode()); System.err.println("Response headers: " + apiException.getResponseHeaders()); System.err.println("Reason: " + apiException.getResponseBody()); e.printStackTrace(); } catch (ApiException e) { System.err.println("Exception when calling OpenFgaApi#write"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); e.printStackTrace(); } } }
Name Type Description Notes storeId String body WriteRequest CompletableFuture<ApiResponse<Object>>
No authorization required
- 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. - 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. - CompletableFuture writeAssertions(storeId, authorizationModelId, body)
Upsert assertions for an authorization model ID
The WriteAssertions API will upsert new assertions for an authorization model id, or overwrite the existing ones. An assertion is an object that contains a tuple key, and the expectation of whether a call to the Check API of that tuple key will return true or false.
// 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 | String authorizationModelId = "authorizationModelId_example"; // String | WriteAssertionsRequest body = new WriteAssertionsRequest(); // WriteAssertionsRequest | try { CompletableFuture<Void> result = apiInstance.writeAssertions(storeId, authorizationModelId, body); } catch (ApiException e) { System.err.println("Exception when calling OpenFgaApi#writeAssertions"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } }
Name Type Description Notes storeId String authorizationModelId String body WriteAssertionsRequest CompletableFuture (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code Description Response headers 204 A successful response. - 400 Request failed due to invalid input. - 401 Not authenticated. - 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. - CompletableFuture<ApiResponse> writeAssertions writeAssertionsWithHttpInfo(storeId, authorizationModelId, body)
Upsert assertions for an authorization model ID
The WriteAssertions API will upsert new assertions for an authorization model id, or overwrite the existing ones. An assertion is an object that contains a tuple key, and the expectation of whether a call to the Check API of that tuple key will return true or false.
// Import classes: import dev.openfga.sdk.api.client.ApiClient; import dev.openfga.sdk.api.client.ApiException; import dev.openfga.sdk.api.client.ApiResponse; 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 | String authorizationModelId = "authorizationModelId_example"; // String | WriteAssertionsRequest body = new WriteAssertionsRequest(); // WriteAssertionsRequest | try { CompletableFuture<ApiResponse<Void>> response = apiInstance.writeAssertionsWithHttpInfo(storeId, authorizationModelId, body); System.out.println("Status code: " + response.get().getStatusCode()); System.out.println("Response headers: " + response.get().getHeaders()); } catch (InterruptedException | ExecutionException e) { ApiException apiException = (ApiException)e.getCause(); System.err.println("Exception when calling OpenFgaApi#writeAssertions"); System.err.println("Status code: " + apiException.getCode()); System.err.println("Response headers: " + apiException.getResponseHeaders()); System.err.println("Reason: " + apiException.getResponseBody()); e.printStackTrace(); } catch (ApiException e) { System.err.println("Exception when calling OpenFgaApi#writeAssertions"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); e.printStackTrace(); } } }
Name Type Description Notes storeId String authorizationModelId String body WriteAssertionsRequest CompletableFuture<ApiResponse>
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code Description Response headers 204 A successful response. - 400 Request failed due to invalid input. - 401 Not authenticated. - 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. - CompletableFuture writeAuthorizationModel(storeId, body)
Create a new authorization model
The WriteAuthorizationModel API will add a new authorization model to a store. Each item in the `type_definitions` array is a type definition as specified in the field `type_definition`. The response will return the authorization model's ID in the `id` field. ## Example To add an authorization model with `user` and `document` type definitions, call POST authorization-models API with the body: ```json { "type_definitions":[ { "type":"user" }, { "type":"document", "relations":{ "reader":{ "union":{ "child":[ { "this":{} }, { "computedUserset":{ "object":"", "relation":"writer" } } ] } }, "writer":{ "this":{} } } } ] } ``` OpenFGA's response will include the version id for this authorization model, which will look like ``` {"authorization_model_id": "01G50QVV17PECNVAHX1GG4Y5NC"} ```
// 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 | WriteAuthorizationModelRequest body = new WriteAuthorizationModelRequest(); // WriteAuthorizationModelRequest | try { CompletableFuture<WriteAuthorizationModelResponse> result = apiInstance.writeAuthorizationModel(storeId, body); System.out.println(result.get()); } catch (ApiException e) { System.err.println("Exception when calling OpenFgaApi#writeAuthorizationModel"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } }
Name Type Description Notes storeId String body WriteAuthorizationModelRequest CompletableFuture<WriteAuthorizationModelResponse>
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code Description Response headers 201 A successful response. - 400 Request failed due to invalid input. - 401 Not authenticated. - 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. - CompletableFuture<ApiResponse> writeAuthorizationModel writeAuthorizationModelWithHttpInfo(storeId, body)
Create a new authorization model
The WriteAuthorizationModel API will add a new authorization model to a store. Each item in the `type_definitions` array is a type definition as specified in the field `type_definition`. The response will return the authorization model's ID in the `id` field. ## Example To add an authorization model with `user` and `document` type definitions, call POST authorization-models API with the body: ```json { "type_definitions":[ { "type":"user" }, { "type":"document", "relations":{ "reader":{ "union":{ "child":[ { "this":{} }, { "computedUserset":{ "object":"", "relation":"writer" } } ] } }, "writer":{ "this":{} } } } ] } ``` OpenFGA's response will include the version id for this authorization model, which will look like ``` {"authorization_model_id": "01G50QVV17PECNVAHX1GG4Y5NC"} ```
// Import classes: import dev.openfga.sdk.api.client.ApiClient; import dev.openfga.sdk.api.client.ApiException; import dev.openfga.sdk.api.client.ApiResponse; 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 | WriteAuthorizationModelRequest body = new WriteAuthorizationModelRequest(); // WriteAuthorizationModelRequest | try { CompletableFuture<ApiResponse<WriteAuthorizationModelResponse>> response = apiInstance.writeAuthorizationModelWithHttpInfo(storeId, body); System.out.println("Status code: " + response.get().getStatusCode()); System.out.println("Response headers: " + response.get().getHeaders()); System.out.println("Response body: " + response.get().getData()); } catch (InterruptedException | ExecutionException e) { ApiException apiException = (ApiException)e.getCause(); System.err.println("Exception when calling OpenFgaApi#writeAuthorizationModel"); System.err.println("Status code: " + apiException.getCode()); System.err.println("Response headers: " + apiException.getResponseHeaders()); System.err.println("Reason: " + apiException.getResponseBody()); e.printStackTrace(); } catch (ApiException e) { System.err.println("Exception when calling OpenFgaApi#writeAuthorizationModel"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); e.printStackTrace(); } } }
Name Type Description Notes storeId String body WriteAuthorizationModelRequest CompletableFuture<ApiResponse<WriteAuthorizationModelResponse>>
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code Description Response headers 201 A successful response. - 400 Request failed due to invalid input. - 401 Not authenticated. - 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. -