directory
List relations instances
Changed onReturns list of relation instances.
get/api/v3/directory/relations
Request
- The document declares no server URL.
- AuthAPI key in header authorization and API key in header aserto-tenant-id
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
object_typestring
object type
object_idstring
object identifier
relationstring
relation name
subject_typestring
subject type
subject_idstring
subject identifier
subject_relationstring
optional subject relation name
with_objectsboolean
materialize relation objects
with_empty_subject_relationboolean
only return relations that do not have a subject relation.
page.sizeinteger
requested page size, valid value between 1-100 rows (default 100)
page.tokenstring
pagination start token, default ""
Response
A successful response.
Changes
- info
api operation id
directory.v3.relations.listremoved and replaced withdirectory.reader.v3.relations.list
- info
- info
added the new optional
queryrequest parameterwith_empty_subject_relation
- info