Get all users that have a given relation with a given object
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 at most 250, and it will be limited by an execution timeout of 3 seconds, whichever is hit first.
The users given will not be sorted, and therefore two identical calls can give a given different set of users.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Body
Object represents an OpenFGA Object.
An Object is composed of a type and identifier (e.g. 'document:1')
"document:example"
"reader"
The type of results returned. Only accepts exactly one value.
1 element"01G5JAVJ41T49E9TT3SKVS7X1J"
Controls the consistency preference for this request. Default value is UNSPECIFIED, which will have the same behavior as MINIMIZE_LATENCY.
UNSPECIFIED, MINIMIZE_LATENCY, HIGHER_CONSISTENCY "MINIMIZE_LATENCY"
Additional request context that will be used to evaluate any ABAC conditions encountered in the query evaluation.
100Response
A successful response.