Skip to main content

List Users API

· 2 min read

Today we are launching a new API for OpenFGA: ListUsers.

This API will answer the question "what users have relation X with object Y?". This will be useful, for example, in UIs that want to display the list of users that a resource has been shared with, e.g. the "share" dialog in Google Docs.

You can read more about this API here.

How to use it?

ListUsers is available in the latest Release Candidate version of OpenFGA: v1.5.4-rc1.

To be able to call this API, you must turn on this flag on the server: --experimentals enable-list-users. Be sure to also check out the various configuration flags that were added to control its behavior.

You can also call this API via the SDKs:

What's next?

Our next steps look as follows:

  1. Release candidate with experimental flag (now)
  2. Any bug fixes
  3. Stable release with experimental flag
  4. Any performance improvements
  5. Stable release without experimental flag

We want your feedback!

We want to learn how you use this API and how we can improve it!

Please reach out through our community channels with any questions or feedback.