-
Notifications
You must be signed in to change notification settings - Fork 85
chore: list users announcement #731
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
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
0a523bb
chore: list users announcement
miparnisari 11af9d2
add author
miparnisari 0d17c76
address feedback
miparnisari f591fce
add link to release
miparnisari abd5d92
more concise
miparnisari ea84b7c
same as before
miparnisari 9e1d939
add links to sdks
miparnisari 5674cdc
update next steps
miparnisari 777806c
add link to api docs
miparnisari File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
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. | ||
|
||
You can read more about this API [here](https://openfga.dev/api/service#/Relationship%20Queries/ListUsers). | ||
|
||
## 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) | ||
|
||
## 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](https://openfga.dev/community) with any questions or feedback. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.