From 5a084ec3cd0f100f6e7df30e02427ed5300f647f Mon Sep 17 00:00:00 2001 From: Raghd Hamzeh Date: Thu, 10 Aug 2023 15:46:21 -0400 Subject: [PATCH] Initial Commit --- .fossa.yml | 9 + .github/CODEOWNERS | 1 + .github/ISSUE_TEMPLATE/bug_report.md | 64 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 30 +++ .gitignore | 21 ++ CHANGELOG.md | 0 CONTRIBUTING.md | 46 ++++ LICENSE | 179 ++++++++++++ NOTICE.txt | 51 ++++ README.md | 314 ++++++++++++++++++++++ 10 files changed, 715 insertions(+) create mode 100644 .fossa.yml create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 NOTICE.txt create mode 100644 README.md diff --git a/.fossa.yml b/.fossa.yml new file mode 100644 index 0000000..626f2c7 --- /dev/null +++ b/.fossa.yml @@ -0,0 +1,9 @@ +version: 3 + +server: https://app.fossa.com + +project: + id: github.com/openfga/java-sdk + name: github.com/openfga/java-sdk + link: openfga.dev + url: github.com/openfga/java-sdk diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..2cd386a --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @openfga/core diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..8d84688 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,64 @@ +--- +name: Report an issue +about: Create a bug report about an existing issue. +title: '' +labels: 'bug' +assignees: '' + +--- + +**Please do not report security vulnerabilities here**. See the [Responsible Disclosure Program](https://github.com/openfga/java-sdk/blob/main/.github/SECURITY.md). + +**Thank you in advance for helping us to improve this library!** Please read through the template below and answer all relevant questions. Your additional work here is greatly appreciated and will help us respond as quickly as possible. + +By submitting an issue to this repository, you agree to the terms within the [OpenFGA Code of Conduct](https://github.com/openfga/rfcs/blob/main/CODE-OF-CONDUCT.md). + +### Description + +> Provide a clear and concise description of the issue, including what you expected to happen. + +### Version of SDK + +> v0.2.0 + +### Version of OpenFGA (if known) + +> v1.1.0 + +### OpenFGA Flags/Custom Configuration Applicable + +> environment: +> - OPENFGA_DATASTORE_ENGINE=postgres +> - OPENFGA_DATASTORE_URI=postgres://postgres:password@postgres:5432/postgres?sslmode=disable +> - OPENFGA_TRACE_ENABLED=true +> - OPENFGA_TRACE_SAMPLE_RATIO=1 +> - OPENFGA_TRACE_OTLP_ENDPOINT=otel-collector:4317 +> - OPENFGA_METRICS_ENABLE_RPC_HISTOGRAMS=true + +### Reproduction + +> Detail the steps taken to reproduce this error, what was expected, and whether this issue can be reproduced consistently or if it is intermittent. +> +> 1. Initialize OpenFgaClient with openfga_sdk.ClientConfiguration parameter api_host=127.0.0.1, credentials method client_credentials +> 2. Invoke method read_authorization_models +> 3. See exception thrown + +### Sample Code the Produces Issues + +> +> ``` +> +> ``` + +### Backtrace (if applicable) + +> ``` +> +> ``` + + +### Expected behavior +> A clear and concise description of what you expected to happen. + +### Additional context +> Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..c0d64dd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,30 @@ +--- +name: Feature request +about: Suggest new functionality for this project. +title: '' +labels: 'feature' +assignees: '' + +--- + +**Please do not report security vulnerabilities here**. See the [Responsible Disclosure Program](https://github.com/openfga/java-sdk/blob/main/.github/SECURITY.md). + +**Thank you in advance for helping us to improve this library!** Please read through the template below and answer all relevant questions. Your additional work here is greatly appreciated and will help us respond as quickly as possible. + +By submitting an issue to this repository, you agree to the terms within the [OpenFGA Code of Conduct](https://github.com/openfga/rfcs/blob/main/CODE-OF-CONDUCT.md). + +### Describe the problem you'd like to have solved + +> A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +### Describe the ideal solution + +> A clear and concise description of what you want to happen. + +## Alternatives and current workarounds + +> A clear and concise description of any alternatives you've considered or any workarounds that are currently in place. + +### Additional context + +> Add any other context or screenshots about the feature request here. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a530464 --- /dev/null +++ b/.gitignore @@ -0,0 +1,21 @@ +*.class + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.ear + +# exclude jar for gradle wrapper +!gradle/wrapper/*.jar + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* + +# build files +**/target +target +.gradle +build diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e69de29 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c5ea358 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# Contributing to OpenFGA projects + +A big welcome and thank you for considering contributing to the OpenFGA open source projects. It’s people like you that make it a reality for users in our community. + +Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests. + +### Table of Contents + +* [Code of Conduct](#code-of-conduct) +* [Getting Started](#getting-started) + * [Making Changes](#making-changes) + * [Opening Issues](#opening-issues) + * [Submitting Pull Requests](#submitting-pull-requests) [Note: We are not accepting Pull Requests at this time!] +* [Getting in Touch](#getting-in-touch) + * [Have a question or problem?](#have-a-question-or-problem) + * [Vulnerability Reporting](#vulnerability-reporting) + +## Code of Conduct + +By participating and contributing to this project, you are expected to uphold our [Code of Conduct](https://github.com/openfga/.github/blob/main/CODE_OF_CONDUCT.md). + +## Getting Started + +### Making Changes + +When contributing to a repository, the first step is to open an issue on [sdk-generator](https://github.com/openfga/sdk-generator) to discuss the change you wish to make before making them. + +### Opening Issues + +Before you submit a new issue please make sure to search all open and closed issues. It is possible your feature request/issue has already been answered. Make sure to also check the [OpenFGA discussions](https://github.com/orgs/openfga/discussions). + +That repo includes an issue template that will walk through all the places to check before submitting your issue here. Please follow the instructions there to make sure this is not a duplicate issue and that we have everything we need to research and reproduce this problem. + +### Submitting Pull Requests + +Considering that the SDKs are autogenerated, please make sure to submit your Pull Requests to the [sdk-generator](https://github.com/openfga/sdk-generator). We will not accept PRs to this repository because they will be overwritten on the next sdk generation. + +## Getting in touch + +### Have a question or problem? + +Please do not open issues for general support or usage questions. Instead, join us over in the [OpenFGA discussions](https://github.com/orgs/openfga/discussions) or [support community](https://discord.gg/8naAwJfWN6). + +### Vulnerability Reporting + +Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://github.com/openfga/java-sdk/blob/main/.github/SECURITY.md) details the procedure for disclosing security issues. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4959a5e --- /dev/null +++ b/LICENSE @@ -0,0 +1,179 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + diff --git a/NOTICE.txt b/NOTICE.txt new file mode 100644 index 0000000..a8cb285 --- /dev/null +++ b/NOTICE.txt @@ -0,0 +1,51 @@ +Java SDK for OpenFGA +github.com/openfga/java-sdk + +Copyright (c) 2022 the OpenFGA contributors (https://openfga.dev) + +Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +-------------------------------------------------------------------------------- + + +================================================================================ +================================================================================ + + Third-Party Software for github.com/openfga/java-sdk + +-------------------------------------------------------------------------------- + +The following 3rd-party software packages may be used by or distributed with github.com/openfga/java-sdk. Any information relevant to third-party vendors listed below are collected using common, reasonable means. + +Date generated: N/A + +Revision ID: N/A + +================================================================================ +================================================================================ + + + + + +================================================================================ + + Dependencies + +================================================================================ + + + + +================================================================================ + License + +================================================================================ + + +-------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- + diff --git a/README.md b/README.md new file mode 100644 index 0000000..395c95d --- /dev/null +++ b/README.md @@ -0,0 +1,314 @@ +# .NET SDK for OpenFGA + +[![Release](https://img.shields.io/github/v/release/openfga/java-sdk?sort=semver&color=green)](https://github.com/openfga/java-sdk/releases) +[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE) +[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenfga%2Fjava-sdk.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenfga%2Fjava-sdk?ref=badge_shield) +[![Discord Server](https://img.shields.io/discord/759188666072825867?color=7289da&logo=discord "Discord Server")](https://discord.com/channels/759188666072825867/930524706854031421) +[![Twitter](https://img.shields.io/twitter/follow/openfga?color=%23179CF0&logo=twitter&style=flat-square "@openfga on Twitter")](https://twitter.com/openfga) + +This is an autogenerated SDK for OpenFGA. It provides a wrapper around the [OpenFGA API definition](https://openfga.dev/api). + +## Table of Contents + +- [About OpenFGA](#about) +- [Resources](#resources) +- [Installation](#installation) +- [Getting Started](#getting-started) + - [Initializing the API Client](#initializing-the-api-client) + - [Get your Store ID](#get-your-store-id) + - [Calling the API](#calling-the-api) + - [Stores](#stores) + - [List All Stores](#list-stores) + - [Create a Store](#create-store) + - [Get a Store](#get-store) + - [Delete a Store](#delete-store) + - [Authorization Models](#authorization-models) + - [Read Authorization Models](#read-authorization-models) + - [Write Authorization Model](#write-authorization-model) + - [Read a Single Authorization Model](#read-a-single-authorization-model) + - [Read the Latest Authorization Model](#read-the-latest-authorization-model) + - [Relationship Tuples](#relationship-tuples) + - [Read Relationship Tuple Changes (Watch)](#read-relationship-tuple-changes-watch) + - [Read Relationship Tuples](#read-relationship-tuples) + - [Write (Create and Delete) Relationship Tuples](#write-create-and-delete-relationship-tuples) + - [Relationship Queries](#relationship-queries) + - [Check](#check) + - [Batch Check](#batch-check) + - [Expand](#expand) + - [List Objects](#list-objects) + - [List Relations](#list-relations) + - [Assertions](#assertions) + - [Read Assertions](#read-assertions) + - [Write Assertions](#write-assertions) + - [API Endpoints](#api-endpoints) + - [Models](#models) +- [Contributing](#contributing) + - [Issues](#issues) + - [Pull Requests](#pull-requests) +- [License](#license) + +## About + +[OpenFGA](https://openfga.dev) is an open source Fine-Grained Authorization solution inspired by [Google's Zanzibar paper](https://research.google/pubs/pub48190/). It was created by the FGA team at [Auth0](https://auth0.com) based on [Auth0 Fine-Grained Authorization (FGA)](https://fga.dev), available under [a permissive license (Apache-2)](https://github.com/openfga/rfcs/blob/main/LICENSE) and welcomes community contributions. + +OpenFGA is designed to make it easy for application builders to model their permission layer, and to add and integrate fine-grained authorization into their applications. OpenFGA’s design is optimized for reliability and low latency at a high scale. + + +## Resources + +- [OpenFGA Documentation](https://openfga.dev/docs) +- [OpenFGA API Documentation](https://openfga.dev/api/service) +- [Twitter](https://twitter.com/openfga) +- [OpenFGA Discord Community](https://discord.gg/8naAwJfWN6) +- [Zanzibar Academy](https://zanzibar.academy) +- [Google's Zanzibar Paper (2019)](https://research.google/pubs/pub48190/) + +## Installation + +## Getting Started + +### Initializing the API Client + +[Learn how to initialize your SDK](https://openfga.dev/docs/getting-started/setup-sdk-client) + +> The SdkClient will by default retry API requests up to 15 times on 429 and 5xx errors. + +#### No Credentials + +```java +``` + +#### API Token + +```java +``` + +#### Client Credentials + +```java +``` + + +### Get your Store ID + +You need your store id to call the OpenFGA API (unless it is to call the [CreateStore](#create-store) or [ListStores](#list-stores) methods). + +If your server is configured with [authentication enabled](https://openfga.dev/docs/getting-started/setup-openfga#configuring-authentication), you also need to have your credentials ready. + +### Calling the API + +#### Stores + +##### List Stores + +Get a paginated list of stores. + +[API Documentation](https://openfga.dev/api/service/docs/api#/Stores/ListStores) + +```java +``` + +##### Create Store + +Initialize a store. + +[API Documentation](https://openfga.dev/api/service/docs/api#/Stores/CreateStore) + +```java +``` + +##### Get Store + +Get information about the current store. + +[API Documentation](https://openfga.dev/api/service/docs/api#/Stores/GetStore) + +> Requires a client initialized with a storeId + +```java +``` + +##### Delete Store + +Delete a store. + +[API Documentation](https://openfga.dev/api/service/docs/api#/Stores/DeleteStore) + +> Requires a client initialized with a storeId + +```java +``` + +#### Authorization Models + +##### Read Authorization Models + +Read all authorization models in the store. + +[API Documentation](https://openfga.dev/api/service#/Authorization%20Models/ReadAuthorizationModels) + +```java +``` + +##### Write Authorization Model + +Create a new authorization model. + +[API Documentation](https://openfga.dev/api/service#/Authorization%20Models/WriteAuthorizationModel) + +> Note: To learn how to build your authorization model, check the Docs at https://openfga.dev/docs. + +> Learn more about [the OpenFGA configuration language](https://openfga.dev/docs/configuration-language). + +> You can use the [OpenFGA Syntax Transformer](https://github.com/openfga/syntax-transformer) to convert between the friendly DSL and the JSON authorization model. + +```java +``` + +#### Read a Single Authorization Model + +Read a particular authorization model. + +[API Documentation](https://openfga.dev/api/service#/Authorization%20Models/ReadAuthorizationModel) + +```java +``` + +##### Read the Latest Authorization Model + +Reads the latest authorization model (note: this ignores the model id in configuration). + +[API Documentation](https://openfga.dev/api/service#/Authorization%20Models/ReadAuthorizationModel) + +```java +``` + +#### Relationship Tuples + +##### Read Relationship Tuple Changes (Watch) + +Reads the list of historical relationship tuple writes and deletes. + +[API Documentation](https://openfga.dev/api/service#/Relationship%20Tuples/ReadChanges) + +```java +``` + +##### Read Relationship Tuples + +Reads the relationship tuples stored in the database. It does not evaluate nor exclude invalid tuples according to the authorization model. + +[API Documentation](https://openfga.dev/api/service#/Relationship%20Tuples/Read) + +```java +``` + +##### Write (Create and Delete) Relationship Tuples + +Create and/or delete relationship tuples to update the system state. + +[API Documentation](https://openfga.dev/api/service#/Relationship%20Tuples/Write) + +###### Transaction mode (default) + +By default, write runs in a transaction mode where any invalid operation (deleting a non-existing tuple, creating an existing tuple, one of the tuples was invalid) or a server error will fail the entire operation. + +```java +``` + +Convenience `WriteTuples` and `DeleteTuples` methods are also available. + +###### Non-transaction mode + +The SDK will split the writes into separate requests and send them sequentially to avoid violating rate limits. + +```java +``` + +#### Relationship Queries + +##### Check + +Check if a user has a particular relation with an object. + +[API Documentation](https://openfga.dev/api/service#/Relationship%20Queries/Check) + +```java +``` + +##### Batch Check + +Run a set of [checks](#check). Batch Check will return `allowed: false` if it encounters an error, and will return the error in the body. +If 429s or 5xxs are encountered, the underlying check will retry up to 15 times before giving up. + +```java +``` + +##### Expand + +Expands the relationships in userset tree format. + +[API Documentation](https://openfga.dev/api/service#/Relationship%20Queries/Expand) + +```java +``` + +#### List Objects + +List the objects of a particular type a user has access to. + +[API Documentation](https://openfga.dev/api/service#/Relationship%20Queries/ListObjects) + +```java +``` + +#### List Relations + +List the relations a user has on an object. + +```java +``` + +### Assertions + +#### Read Assertions + +Read assertions for a particular authorization model. + +[API Documentation](https://openfga.dev/api/service#/Assertions/Read%20Assertions) + +```java +``` + +#### Write Assertions + +Update the assertions for a particular authorization model. + +[API Documentation](https://openfga.dev/api/service#/Assertions/Write%20Assertions) + +```java +``` + +### API Endpoints + +### Models + +## Contributing + +### Issues + +If you have found a bug or if you have a feature request, please report them on the [sdk-generator repo](https://github.com/openfga/sdk-generator/issues) issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. + +### Pull Requests + +All changes made to this repo will be overwritten on the next generation, so we kindly ask that you send all pull requests related to the SDKs to the [sdk-generator repo](https://github.com/openfga/sdk-generator) instead. + +## Author + +[OpenFGA](https://github.com/openfga) + +## License + +This project is licensed under the Apache-2.0 license. See the [LICENSE](https://github.com/openfga/java-sdk/blob/main/LICENSE) file for more info. + +The code in this repo was auto generated by [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) from a template based on the [java template](https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources/Java), licensed under the [Apache License 2.0](https://github.com/OpenAPITools/openapi-generator/blob/master/LICENSE). \ No newline at end of file