OpenFGA v0.2.0 is out! 🎉

[rhamzeh]

The v0.2.0 release of OpenFGA is now out!

If you are running through docker:

• If you are targeting latest, make sure to update by running docker pull openfga/openfga
• If you are targeting pinned releases, make sure to set your pinned version to: openfga/openfga:v0.2.0

Changes in this release

Added

• ListObjects API (feat: implementation of ListObjects and StreamedListObjects API endpoints openfga#145)

  The biggest addition in this release is support for the ListObjects API described in the ListObjects RFC.

  This API provides a way to list all of the objects (of a particular type) that a user has a relationship with. It provides a solution to the Search with Permissions (Option 3) use case for access-aware filtering on smaller object collections.

  As an example, using this API, you would be able to get the list of ids of all the documents that Anne (a user in your system) can view.

  POST /stores/${FGA_STORE_ID}/list-objects
  
  {"user":"anne","type":"document","relation":"can_view"}

  And the response will be similar to:

  {"object_ids":["2022-roadmap","marketing-plan","..."]}

  This addition brings with it two new server configuration options --listObjects-deadline and --listObjects-max-results. These configurations help protect the server from excessively long lived and large responses.

  ⚠️ If --listObjects-deadline or --listObjects-max-results are provided, the endpoint may only return a subset of the data. If you provide the deadline but returning all of the results would take longer than the deadline, then you may not get all of the results. If you limit the max results to 1, then you'll get at most 1 result.

  While this is a working initial implementation of the ListObjects API to allow users to try it out and provide feedback, its performance leaves a lot to be desired. We will be continuously working on improving its performance and response time as mentioned in the RFC, but we would love your feedback on the API semantics and whether it is useful for you.

  Support for ListObjects has been added to v0.0.2 of our Go, JavaScript and .NET SDKs.

• Support for presharedkey authentication in the Playground (feat: add support for presharedkey auth in the Playground openfga#141)

  The embedded Playground now works if you run OpenFGA using one or more preshared keys for authentication. OIDC authentication remains unsupported for the Playground at this time.