1"use strict";(globalThis.webpackChunkopenfga_dev=globalThis.webpackChunkopenfga_dev||[]).push([[6810],{8295(e,t,s){s.r(t),s.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>n,toc:()=>h});var n=s(7636),a=s(4848),i=s(8453);const r={title:"List Users API",description:"List Users API",slug:"list-users-announcement",date:new Date("2024-05-30T00:00:00.000Z"),last_update:{date:"2024-05-30"},authors:"miparnisari",tags:["openfga","features"],image:"https://openfga.dev/img/og-rich-embed.png",hide_table_of_contents:!1},o="New ListUsers API on OpenFGA",l={authorsImageUrls:[void 0]},h=[{value:"How to use it?",id:"how-to-use-it",level:2},{value:"We want your feedback!",id:"we-want-your-feedback",level:2}];function c(e){const t={a:"a",code:"code",h2:"h2",p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.p,{children:"Today we are launching a new API for OpenFGA: ListUsers."}),"\n",(0,a.jsx)(t.p,{children:'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.'}),"\n",(0,a.jsxs)(t.p,{children:["You can read more about it in the ",(0,a.jsx)(t.a,{href:"https://openfga.dev/docs/api/service/relationship-queries/list-the-users-matching-the-provided-filter-who-have-a-certain-relation-to-a-particular-type",children:"API docs"})," and the ",(0,a.jsx)(t.a,{href:"https://openfga.dev/docs/getting-started/perform-list-users",children:"product documentation"}),"."]}),"\n",(0,a.jsx)(t.h2,{id:"how-to-use-it",children:"How to use it?"}),"\n",(0,a.jsxs)(t.p,{children:["ListUsers is available in OpenFGA starting with ",(0,a.jsx)(t.a,{href:"https://github.com/openfga/openfga/releases/tag/v1.5.4",children:"v1.5.4"}),"."]}),"\n",(0,a.jsxs)(t.p,{children:["To be able to call this API, you must turn on this flag on the server: ",(0,a.jsx)(t.code,{children:"--experimentals enable-list-users"}),". Be sure to also check out the various configuration flags that were added to control its behavior."]}),"\n",(0,a.jsxs)(t.p,{children:["The new functionality is available on the latest versions of the ",(0,a.jsx)(t.a,{href:"https://github.com/openfga/java-sdk/",children:"Java"}),", ",(0,a.jsx)(t.a,{href:"https://github.com/openfga/dotnet-sdk/",children:".NET"}),", ",(0,a.jsx)(t.a,{href:"https://github.com/openfga/go-sdk/",children:"Go"})," and ",(0,a.jsx)(t.a,{href:"https://github.com/openfga/js-sdk/",children:"Javascript SDK"}),", ",(0,a.jsx)(t.a,{href:"https://github.com/openfga/cli?tab=readme-ov-file#list-users",children:"CLI"})," and ",(0,a.jsx)(t.a,{href:"https://marketplace.visualstudio.com/items?itemName=openfga.openfga-vscode",children:"VS Code integration"}),"."]}),"\n",(0,a.jsx)(t.p,{children:"We'll be releasing support for the Python SDK soon."}),"\n",(0,a.jsx)(t.h2,{id:"we-want-your-feedback",children:"We want your feedback!"}),"\n",(0,a.jsx)(t.p,{children:"We want to learn how you use this API and how we can improve it!"}),"\n",(0,a.jsxs)(t.p,{children:["Please reach out through our ",(0,a.jsx)(t.a,{href:"https://openfga.dev/community",children:"community channels"})," with any questions or feedback."]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},8453(e,t,s){s.d(t,{R:()=>r,x:()=>o});var n=s(6540);const a={},i=n.createContext(a);function r(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),n.createElement(i.Provider,{value:t},e.children)}},7636(e){e.exports=JSON.parse('{"permalink":"/blog/list-users-announcement","source":"@site/blog/list-users-announcement.md","title":"List Users API","description":"List Users API","date":"2024-05-30T00:00:00.000Z","tags":[{"inline":true,"label":"openfga","permalink":"/blog/tags/openfga"},{"inline":true,"label":"features","permalink":"/blog/tags/features"}],"readingTime":1.29,"hasTruncateMarker":true,"authors":[{"name":"Maria Ines Parnisari","url":"https://github.com/miparnisari","imageURL":"/img/blog/authors/miparnisari.jpg","key":"miparnisari","page":null}],"frontMatter":{"title":"List Users API","description":"List Users API","slug":"list-users-announcement","date":"2024-05-30T00:00:00.000Z","last_update":{"date":"2024-05-30"},"authors":"miparnisari","tags":["openfga","features"],"image":"https://openfga.dev/img/og-rich-embed.png","hide_table_of_contents":false},"unlisted":false,"prevItem":{"title":"Fine-Grained News - May 2024","permalink":"/blog/fine-grained-news-2024-05"},"nextItem":{"title":"Fine-Grained News - April 2024","permalink":"/blog/fine-grained-news-2024-04"}}')}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.