Authzed · Schema

ReadRelationshipsResponse

ReadRelationshipsResponse contains a Relationship found that matches the specified relationship filter(s). A instance of this response message will be streamed to the client for each relationship found.

AuthorizationAccess ControlPermissionsZanzibarSpiceDBgRPCRESTRelationship-Based Access ControlReBACFine-Grained AuthorizationIdentitySecurity

Properties

Name	Type	Description
readAt	object	read_at is the ZedToken at which the relationship was found.
relationship	object	relationship is the found relationship.
afterResultCursor	object	after_result_cursor holds a cursor that can be used to resume the ReadRelationships stream after this result.

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "properties": {
    "readAt": {
      "$ref": "#/components/schemas/ZedToken",
      "description": "read_at is the ZedToken at which the relationship was found."
    },
    "relationship": {
      "$ref": "#/components/schemas/Relationship",
      "description": "relationship is the found relationship."
    },
    "afterResultCursor": {
      "$ref": "#/components/schemas/v1.Cursor",
      "description": "after_result_cursor holds a cursor that can be used to resume the ReadRelationships stream after this\nresult."
    }
  },
  "description": "ReadRelationshipsResponse contains a Relationship found that matches the\nspecified relationship filter(s). A instance of this response message will\nbe streamed to the client for each relationship found.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/authzed/main/json-schema/ReadRelationshipsResponse.json",
  "title": "ReadRelationshipsResponse"
}