OpenFGA Sample Stores

This repository contains sample store models for OpenFGA.

Table of Contents

• Sample Store Models
• Creating your store and loading sample data
• Modeling resources
• OpenFGA models in open source projects
• Resources

Sample Store Models

• 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
• Modeling ABAC with ReBAC
• Modeling multi-tenant Role-Based Access Control

Creating your store and loading sample data

To try this out, you need the following tools installed:

• The fga CLI, follow the installation instructions here to get it
• git

1. Clone this repository

git clone https://github.com/openfga/sample-stores.git openfga-sample-stores && cd $_

2. 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"

Modeling Resources

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

OpenFGA models in open source projects

• canonical/lxd
• canonical/identity-platform-login-ui
• canonical/jimm
• lxc/incus
• mindersec/minder
• datum-cloud/datum
• instill-ai/pipeline-backend
• virtool/virtool
• concrete-utopia/utopia
• Cross-Lab-Project/crosslab
• grafana/grafana
• sourcegraph/sourcegraph-public-snapshot
• klothoplatform/infracopilot
• ZEISS/knox
• Lakekeeper

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.

Resources

• OpenFGA Documentation
• OpenFGA on GitHub
• OpenFGA on Twitter
• Zanzibar Academy
• Authorization in Software Podcast
• OpenFGA Community
• FGA Playground