This repository contains sample store models for OpenFGA.
- Sample Store Models
- Creating your store and loading sample data
- Modeling resources
- OpenFGA models in open source projects
- Resources
- GitHub
- Google Drive
- Expenses
- IoT
- Slack
- Custom Roles
- Entitlements
- Advanced Entitlements
- Banking
- IP Based Access
- Super-Admin
- Temporal Access
- Group Resource Attributes
- Conditions Data Types
- Developer Portal
To try this out, you need the following tools installed:
- The
fga
CLI, follow the installation instructions here to get it git
- Clone this repository
git clone https://github.com/openfga/sample-stores.git openfga-sample-stores && cd $_
- Use the
fga
CLI to test the store you choose (e.g.github
,custom-roles
, etc..)
SAMPLE_STORE=github
fga model test --tests "stores/${SAMPLE_STORE}/store.fga.yaml"
The OpenFGA Getting Started documentation is a great way to learn about FGA modeling. These two articles illustrate how you can create a model following the documentation steps:
- Implementing Multi-Tenancy in Chroma: Part 2 - Authorization Model with OpenFGA
- Introduction into OpenFGA
- canonical/lxd
- canonical/identity-platform-login-ui
- lxc/incus
- stacklok/minder
- datumforge/datum
- instill-ai/pipeline-backend
- virtool/virtool
- concrete-utopia/utopia
- Cross-Lab-Project/crosslab
- grafana/grafana
- sourcegraph/sourcegraph-public-snapshot
If you are using OpenFGA in your open source project, please let us know by opening a PR to add your model to this list.