Skip to content

openfga/intellij-plugin

OpenFGA plugin for JetBrain IDEs

This is the official IntelliJ plugin for OpenFGA.

OpenSSF Scorecard Join our community X

About

OpenFGA is an open source Fine-Grained Authorization solution inspired by Google's Zanzibar paper. It was created by the FGA team at Auth0 based on Auth0 Fine-Grained Authorization (FGA), available under a permissive license (Apache-2) 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

Installation

From JetBrains Marketplace

Install directly from the JetBrains Marketplace, or from within your IDE:

  1. Go to Settings > Plugins > Marketplace
  2. Search for OpenFGA
  3. Click Install

Manual Installation

Alternatively, you can install the plugin from disk:

  1. Download the latest release zip from GitHub Releases, or build it yourself with ./gradlew buildPlugin (output will be in build/distributions/)
  2. Go to Settings > Plugins > ⚙️ > Install Plugin from Disk...
  3. Select the plugin zip file

manual_install.png

Usage

  • OpenFGA syntax highlighting for dark and light themes openfga_dark_theme.png
  • DSL syntax support (associated with .fga and .openfga file extensions) syntax.png
  • DSL syntax injection for YAML store files (associated with .fga.yaml and .openfga.yaml file extensions) store_syntax.png
  • Authorization model dsl file template template.png
  • Authorization model dsl live templates live_templates.png
  • Generate json file from DSL (requires OpenFGA CLI to be installed) cli_setup.png transform_json.png
  • Configure servers in OpenFGA tool window server_setup.png

Roadmap

A rough roadmap for development priorities.

Contributing

See the DEVELOPMENT and CONTRIBUTING.

Author

OpenFGA

Acknowledgments

A special thanks to Yann D'Isanto for the contribution of their codebase, which this project is built upon.

License

This project is licensed under the Apache-2.0 license. See the LICENSE file for more info.

About

OpenFGA plugin for JetBrain IDEs.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors