Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: list users announcement #731

Merged
merged 9 commits into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion blog/authors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,8 @@ aaguiar:
eharris:
name: Ewan Harris
url: https://github.com/ewanharris
image_url: /img/blog/authors/ewan.jpg
image_url: /img/blog/authors/ewan.jpg
miparnisari:
name: Maria Ines Parnisari
url: https://github.com/miparnisari
image_url: /img/blog/authors/miparnisari.jpg
44 changes: 44 additions & 0 deletions blog/list-users-announcement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: List Users API
description: List Users API
slug: list-users-announcement
date: 2024-04-30
authors: miparnisari
tags: [openfga,features]
image: https://openfga.dev/img/og-rich-embed.png
hide_table_of_contents: false
---
# New ListUsers API on OpenFGA

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.

## How to use it?

ListUsers is available in the latest Release Candidate version of OpenFGA: [v1.5.4-rc1](https://github.com/openfga/openfga/releases/tag/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:
- [Java v0.4.2](https://github.com/openfga/java-sdk/releases/tag/v0.4.2)
- [.NET v0.3.2](https://github.com/openfga/dotnet-sdk/releases/tag/v0.3.2)
- [Go v0.3.6](https://github.com/openfga/go-sdk/releases/tag/v0.3.6)
- [Javascript v0.4.0](https://github.com/openfga/js-sdk/releases/tag/v0.4.0)

miparnisari marked this conversation as resolved.
Show resolved Hide resolved
## What's next?

We have plans to add a Streaming variant to this endpoint, which will allow you to get real-time results, as soon as they become available.

Our next steps look as follows:

1. Release candidate with experimental flag (now)
2. Addition of Streaming variant plus any fixes,
miparnisari marked this conversation as resolved.
Show resolved Hide resolved
3. Stable release with experimental flag,
miparnisari marked this conversation as resolved.
Show resolved Hide resolved
4. Stable release without experimental flag.
miparnisari marked this conversation as resolved.
Show resolved Hide resolved

## 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](https://openfga.dev/community) with any questions or feedback.
3 changes: 3 additions & 0 deletions static/img/blog/authors/miparnisari.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading