From 0a523bb2087b961bd2181cba4a63957bed544ff3 Mon Sep 17 00:00:00 2001 From: Maria Ines Parnisari Date: Mon, 29 Apr 2024 11:17:28 -0700 Subject: [PATCH 1/9] chore: list users announcement --- blog/list-users-announcement.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 blog/list-users-announcement.md diff --git a/blog/list-users-announcement.md b/blog/list-users-announcement.md new file mode 100644 index 000000000..63f28dd09 --- /dev/null +++ b/blog/list-users-announcement.md @@ -0,0 +1,29 @@ +--- +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 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. To use it you need to download [v1.5.4-RC](TBD) of OpenFGA. Be sure to check out the various configuration flags that were added, too. + +## What's next? + +We have plans to add a Streaming variant to this endpoint, which will allow you to get results as soon as they are found. + +## Reach out! + +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. From 11af9d2c5747276187692adf48e3df76c8edc240 Mon Sep 17 00:00:00 2001 From: Maria Ines Parnisari Date: Mon, 29 Apr 2024 11:39:26 -0700 Subject: [PATCH 2/9] add author --- blog/authors.yml | 6 +++++- static/img/blog/authors/miparnisari.jpg | 3 +++ 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 static/img/blog/authors/miparnisari.jpg diff --git a/blog/authors.yml b/blog/authors.yml index b6fe0585b..2720fae2c 100644 --- a/blog/authors.yml +++ b/blog/authors.yml @@ -6,4 +6,8 @@ aaguiar: eharris: name: Ewan Harris url: https://github.com/ewanharris - image_url: /img/blog/authors/ewan.jpg \ No newline at end of file + image_url: /img/blog/authors/ewan.jpg +miparnisari: + name: Maria Ines Parnisari + url: https://github.com/miparnisari + image_url: /img/blog/authors/miparnisari.jpg \ No newline at end of file diff --git a/static/img/blog/authors/miparnisari.jpg b/static/img/blog/authors/miparnisari.jpg new file mode 100644 index 000000000..9714b2aed --- /dev/null +++ b/static/img/blog/authors/miparnisari.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a2d879495991865e2c5e6ed08bb815b02372bb17e052b172b179454be7c0274f +size 1679955 From 0d17c7694c56e772b33a7e7e26be15f24c996d0f Mon Sep 17 00:00:00 2001 From: Maria Ines Parnisari Date: Tue, 30 Apr 2024 09:40:40 -0700 Subject: [PATCH 3/9] address feedback --- blog/list-users-announcement.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/blog/list-users-announcement.md b/blog/list-users-announcement.md index 63f28dd09..608a80fe3 100644 --- a/blog/list-users-announcement.md +++ b/blog/list-users-announcement.md @@ -12,17 +12,26 @@ hide_table_of_contents: false 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 UIs that want to display the list of users that a resource has been shared with, e.g. the "share" dialog in Google Docs. +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. To use it you need to download [v1.5.4-RC](TBD) of OpenFGA. Be sure to check out the various configuration flags that were added, too. +ListUsers is available in the latest Release Candidate version of OpenFGA. To use it you need to download [v1.5.4-RC](TBD) of OpenFGA and enable the endpoint via the flag `--experimentals enable-list-users`. + +Be sure to check out the various configuration flags that were added, too. ## What's next? -We have plans to add a Streaming variant to this endpoint, which will allow you to get results as soon as they are found. +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 roadmap looks as follows: + +1. Release candidate with experimental flag (now) +2. Addition of Streaming variant, +3. Stable release with experimental flag, +4. Stable release without experimental flag. -## Reach out! +## We want your feedback! We want to learn how you use this API and how we can improve it! From f591fcef8eff9e870fc57d77930a8706ee3db0b8 Mon Sep 17 00:00:00 2001 From: Maria Ines Parnisari Date: Wed, 1 May 2024 16:07:11 -0700 Subject: [PATCH 4/9] add link to release --- blog/list-users-announcement.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/blog/list-users-announcement.md b/blog/list-users-announcement.md index 608a80fe3..b07843249 100644 --- a/blog/list-users-announcement.md +++ b/blog/list-users-announcement.md @@ -16,7 +16,7 @@ This API will answer the question "what users have relation X with object Y?". T ## How to use it? -ListUsers is available in the latest Release Candidate version of OpenFGA. To use it you need to download [v1.5.4-RC](TBD) of OpenFGA and enable the endpoint via the flag `--experimentals enable-list-users`. +ListUsers is available in the latest Release Candidate version of OpenFGA. To use it you need to download [v1.5.4-rc1](https://github.com/openfga/openfga/releases/tag/v1.5.4-rc1) of OpenFGA and enable the endpoint via the flag `--experimentals enable-list-users`. Be sure to check out the various configuration flags that were added, too. From abd5d928238a71112f20deab095b0ff16cdb2f9c Mon Sep 17 00:00:00 2001 From: Maria Ines Parnisari Date: Wed, 1 May 2024 16:18:04 -0700 Subject: [PATCH 5/9] more concise --- blog/list-users-announcement.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/blog/list-users-announcement.md b/blog/list-users-announcement.md index b07843249..fdf1a5f65 100644 --- a/blog/list-users-announcement.md +++ b/blog/list-users-announcement.md @@ -16,9 +16,9 @@ This API will answer the question "what users have relation X with object Y?". T ## How to use it? -ListUsers is available in the latest Release Candidate version of OpenFGA. To use it you need to download [v1.5.4-rc1](https://github.com/openfga/openfga/releases/tag/v1.5.4-rc1) of OpenFGA and enable the endpoint via the flag `--experimentals enable-list-users`. +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). -Be sure to check out the various configuration flags that were added, too. +To be able to call this API, you must turn on this flag: `--experimentals enable-list-users`. Be sure to also check out the various configuration flags that were added to control its behavior. ## What's next? From ea84b7c0ac11d4a34cfb5a42d21c5d464e60d533 Mon Sep 17 00:00:00 2001 From: Maria Ines Parnisari Date: Wed, 1 May 2024 16:18:48 -0700 Subject: [PATCH 6/9] same as before --- blog/list-users-announcement.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/blog/list-users-announcement.md b/blog/list-users-announcement.md index fdf1a5f65..9d9b731c5 100644 --- a/blog/list-users-announcement.md +++ b/blog/list-users-announcement.md @@ -27,7 +27,7 @@ We have plans to add a Streaming variant to this endpoint, which will allow you Our roadmap looks as follows: 1. Release candidate with experimental flag (now) -2. Addition of Streaming variant, +2. Addition of Streaming variant plus any fixes, 3. Stable release with experimental flag, 4. Stable release without experimental flag. From 9e1d93933e62c90565643f5705b1d00c8deb261e Mon Sep 17 00:00:00 2001 From: Maria Ines Parnisari Date: Thu, 2 May 2024 19:54:13 -0700 Subject: [PATCH 7/9] add links to sdks --- blog/list-users-announcement.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/blog/list-users-announcement.md b/blog/list-users-announcement.md index 9d9b731c5..847050103 100644 --- a/blog/list-users-announcement.md +++ b/blog/list-users-announcement.md @@ -18,13 +18,19 @@ This API will answer the question "what users have relation X with object Y?". T 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: `--experimentals enable-list-users`. Be sure to also check out the various configuration flags that were added to control its behavior. +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? 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 roadmap looks as follows: +Our next steps look as follows: 1. Release candidate with experimental flag (now) 2. Addition of Streaming variant plus any fixes, From 5674cdc486f839a47b8c17b94e63a9901ebec813 Mon Sep 17 00:00:00 2001 From: Maria Ines Parnisari Date: Mon, 6 May 2024 09:31:42 -0700 Subject: [PATCH 8/9] update next steps --- blog/list-users-announcement.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/blog/list-users-announcement.md b/blog/list-users-announcement.md index 847050103..318dd7391 100644 --- a/blog/list-users-announcement.md +++ b/blog/list-users-announcement.md @@ -28,14 +28,13 @@ You can also call this API via the SDKs: ## 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, -3. Stable release with experimental flag, -4. Stable release without experimental flag. +2. Any bug fixes +3. Stable release with experimental flag +4. Any performance improvements +5. Stable release without experimental flag ## We want your feedback! From 777806cf5d3ffcdd3fcd2d80c1d258a139bff55c Mon Sep 17 00:00:00 2001 From: Maria Ines Parnisari Date: Mon, 6 May 2024 09:37:51 -0700 Subject: [PATCH 9/9] add link to api docs --- blog/list-users-announcement.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/blog/list-users-announcement.md b/blog/list-users-announcement.md index 318dd7391..bdd8c74a3 100644 --- a/blog/list-users-announcement.md +++ b/blog/list-users-announcement.md @@ -14,6 +14,8 @@ 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).