Get all objects of the given type that the user has a relation with
The ListObjects API returns a list of all the objects of the given type that the user has a relation with.
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.
By default, the Check API caches results for a short time to optimize performance. You may specify a value of HIGHER_CONSISTENCY for the optional consistency parameter in the body to inform the server that higher consistency is preferred at the expense of increased latency. Consideration should be given to the increased latency if requesting higher consistency.
The response will contain the related objects in an array in the “objects” field of the response and they will be strings in the object format <type>:<id> (e.g. “document:roadmap”).
The number of objects in the response array will be at most 10000, and it will be limited by an execution timeout of 3 seconds, whichever is hit first.
The objects given will not be sorted, and therefore two identical calls can give a given different set of objects.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Body
"reader"
"document"
1 - 512"user:anne"
"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.
Response
A successful response.