You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-1
Original file line number
Diff line number
Diff line change
@@ -832,7 +832,7 @@ namespace Example {
832
832
|[**GetStore**](docs/OpenFgaApi.md#getstore)|**GET** /stores/{store_id} | Get a store |
833
833
|[**ListObjects**](docs/OpenFgaApi.md#listobjects)|**POST** /stores/{store_id}/list-objects | List all objects of the given type that the user has a relation with |
834
834
|[**ListStores**](docs/OpenFgaApi.md#liststores)|**GET** /stores | List all stores |
835
-
|[**ListUsers**](docs/OpenFgaApi.md#listusers)|**POST** /stores/{store_id}/list-users |[EXPERIMENTAL]List the users matching the provided filter who have a certain relation to a particular type. |
835
+
|[**ListUsers**](docs/OpenFgaApi.md#listusers)|**POST** /stores/{store_id}/list-users | List the users matching the provided filter who have a certain relation to a particular type. |
836
836
|[**Read**](docs/OpenFgaApi.md#read)|**POST** /stores/{store_id}/read | Get tuples from the store that matches a query, without following userset rewrite rules |
837
837
|[**ReadAssertions**](docs/OpenFgaApi.md#readassertions)|**GET** /stores/{store_id}/assertions/{authorization_model_id} | Read assertions for an authorization model ID |
838
838
|[**ReadAuthorizationModel**](docs/OpenFgaApi.md#readauthorizationmodel)|**GET** /stores/{store_id}/authorization-models/{id} | Return a particular version of an authorization model |
**Trace** | **bool** | Defaults to false. Making it true has performance implications. | [optional][readonly]
11
11
**Context** | **Object** | Additional request context that will be used to evaluate any ABAC conditions encountered in the query evaluation. | [optional]
- UNSPECIFIED: Default if not set. Behavior will be the same as MINIMIZE_LATENCY - MINIMIZE_LATENCY: Minimize latency at the potential expense of lower consistency. - HIGHER_CONSISTENCY: Prefer higher consistency, at the potential expense of increased latency.
**Context** | **Object** | Additional request context that will be used to evaluate any ABAC conditions encountered in the query evaluation. | [optional]
**Context** | **Object** | Additional request context that will be used to evaluate any ABAC conditions encountered in the query evaluation. | [optional]
[**GetStore**](OpenFgaApi.md#getstore) | **GET** /stores/{store_id} | Get a store
12
12
[**ListObjects**](OpenFgaApi.md#listobjects) | **POST** /stores/{store_id}/list-objects | List all objects of the given type that the user has a relation with
13
13
[**ListStores**](OpenFgaApi.md#liststores) | **GET** /stores | List all stores
14
-
[**ListUsers**](OpenFgaApi.md#listusers) | **POST** /stores/{store_id}/list-users | [EXPERIMENTAL]List the users matching the provided filter who have a certain relation to a particular type.
14
+
[**ListUsers**](OpenFgaApi.md#listusers) | **POST** /stores/{store_id}/list-users | List the users matching the provided filter who have a certain relation to a particular type.
15
15
[**Read**](OpenFgaApi.md#read) | **POST** /stores/{store_id}/read | Get tuples from the store that matches a query, without following userset rewrite rules
16
16
[**ReadAssertions**](OpenFgaApi.md#readassertions) | **GET** /stores/{store_id}/assertions/{authorization_model_id} | Read assertions for an authorization model ID
17
17
[**ReadAuthorizationModel**](OpenFgaApi.md#readauthorizationmodel) | **GET** /stores/{store_id}/authorization-models/{id} | Return a particular version of an authorization model
@@ -579,9 +579,9 @@ Name | Type | Description | Notes
[EXPERIMENTAL]List the users matching the provided filter who have a certain relation to a particular type.
582
+
List the users matching the provided filter who have a certain relation to a particular type.
583
583
584
-
The ListUsers API returns a list of all the users of a specific type that have a relation to a given object. This API is available in an experimental capacity and can be enabled with the `- -experimentals enable-list-users` flag. To arrive at a result, the API uses: an authorization model, explicit tuples written through the Write API, contextual tuples present in the request, and implicit tuples that exist by virtue of applying set theory (such as `document:2021-budget#viewer@document:2021-budget#viewer`; the set of users who are viewers of `document:2021-budget` are the set of users who are the viewers of `document:2021-budget`). An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. Each of these tuples may have an associated `condition`. You may also provide a `context` object that will be used to evaluate the conditioned tuples in the system. It is strongly recommended to provide a value for all the input parameters of all the conditions, to ensure that all tuples be evaluated correctly. The response will contain the related users in an array in the \"users\" field of the response. These results may include specific objects, usersets or type-bound public access. Each of these types of results is encoded in its own type and not represented as a string.In cases where a type-bound public acces result is returned (e.g. `user:*`), it cannot be inferred that all subjects of that type have a relation to the object; it is possible that negations exist and checks should still be queried on individual subjects to ensure access to that document.The number of users in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_USERS_DEADLINE and by the upper bound specified in the flag OPENFGA_LIST_USERS_MAX_RESULTS, whichever is hit first. The returned users will not be sorted, and therefore two identical calls may yield different sets of users.
584
+
The ListUsers API returns a list of all the users of a specific type that have a relation to a given object. To arrive at a result, the API uses: an authorization model, explicit tuples written through the Write API, contextual tuples present in the request, and implicit tuples that exist by virtue of applying set theory (such as `document:2021-budget#viewer@document:2021-budget#viewer`; the set of users who are viewers of `document:2021-budget` are the set of users who are the viewers of `document:2021-budget`). An `authorization_model_id` may be specified in the body. If it is not specified, the latest authorization model ID will be used. It is strongly recommended to specify authorization model id for better performance. You may also specify `contextual_tuples` that will be treated as regular tuples. Each of these tuples may have an associated `condition`. You may also provide a `context` object that will be used to evaluate the conditioned tuples in the system. It is strongly recommended to provide a value for all the input parameters of all the conditions, to ensure that all tuples be evaluated correctly. The response will contain the related users in an array in the \"users\" field of the response. These results may include specific objects, usersets or type-bound public access. Each of these types of results is encoded in its own type and not represented as a string.In cases where a type-bound public acces result is returned (e.g. `user:*`), it cannot be inferred that all subjects of that type have a relation to the object; it is possible that negations exist and checks should still be queried on individual subjects to ensure access to that document.The number of users in the response array will be limited by the execution timeout specified in the flag OPENFGA_LIST_USERS_DEADLINE and by the upper bound specified in the flag OPENFGA_LIST_USERS_MAX_RESULTS, whichever is hit first. The returned users will not be sorted, and therefore two identical calls may yield different sets of users.
585
585
586
586
### Example
587
587
```csharp
@@ -610,7 +610,7 @@ namespace Example
610
610
611
611
try
612
612
{
613
-
//[EXPERIMENTAL] List the users matching the provided filter who have a certain relation to a particular type.
613
+
// List the users matching the provided filter who have a certain relation to a particular type.
0 commit comments