Expand Requests provide the ability to list the users in a particular userset.
Unlike Read Responses, Expand Responses follow indirect references.
For example, expanding a
viewer relation, would also include users with
owner relations that
viewer includes as a part of a
It is recommended to specify the
at_revision Zookie value, which will return the namespace's configuration as of the logical timestamp represented by that Zookie.
|No (but recommended)|
Additional Protocol buffer definitions used
Additional Protocol Buffer definitions used
- INVALID_ARGUMENT: a provided value has failed to semantically validate
- RESOURCE_EXHAUSTED: processing the request surpassed the maximum depth of relationship resolution
- FAILED_PRECONDITION: a specified namespace or relation does not exist
For more generic failures, see the gRPC Status Code documentation.
Code Sample Parameter Values
|Tenant Slug||The slug for your tenant|
|Namespace||The namespace of the userset that will be expanded|
|Object ID||The ID of the object whose userset will be expanded|
|Relation||The relation of the object that will be expanded|
|Zookie||The opaque token that signifies a read should be as fresh as the write that produced this token.|