README.md

hide_title
true

OpenFGA Documentation

About OpenFGA

OpenFGA is an open source Fine-Grained Authorization solution based on Google's Zanzibar. It was created by the Okta FGA team and welcomes community contribution. OpenFGA is designed to make it easy for application builders to quickly add fine-grained authorization to their applications. OpenFGA is designed and optimized for reliability and low latency at a high scale.

It offers an HTTP API, a gRPC API, and has SDKs for programming languages including JavaScript, GoLang, .NET and Python and Java.

Resources

• Okta FGA Playground
• Zanzibar Academy
• OpenFGA on Twitter
• OpenFGA Community in Slack and GitHub

Documentation

• What is OpenFGA
• Concepts
• Modeling Language
• Getting Started
  • Setup OpenFGA
    • Configure OpenFGA
    • Docker
    • Kubernetes
    • Playground
  • Install SDK Client
  • Create a Store
  • Setup SDK Client for Store
  • Configure Authorization Model
  • Update Relationship Tuples
  • Perform a Check
  • Perform a List Objects Request
  • Use the FGA CLI
  • Integrate Within a Framework
  • Production Best Practices
  • Managing Tuples and Invoking API Best Practices
• Modeling Overview
  • Getting Started with Modeling
  • Direct Access
  • User Groups
  • Roles and Permissions
  • Parent-Child Relationships
  • Blocklists
  • Public Access
  • Multiple Restrictions
  • Custom Roles
  • Conditions
  • Testing Models
  • Token Claims as Contextual Tuples
  • Contextual and Time-Based Authorization
  • Authorization Through Organization Context
  • Building Blocks
    • Direct Relationships
    • Concentric Relationships
    • Object to Object Relationships
    • Usersets
  • Advanced Use-Cases
    • GitHub
    • Google Drive
    • IoT
    • Slack
    • Entitlements
  • Migrating
    • Migrating Relations
• Interacting with the API
  • Manage User Access
  • Manage Group Access
  • Manage Group Membership
  • Manage Relationships Between Objects
  • Transactional Writes
  • Relationship Queries
  • Get Tuple Changes
  • Search with Permissions