Improved Filtering for Read API

[aaguiarz]

The current implementation of the Read API lets you filter read tuples in a few ways:

• With no filters (read all tuples)
• By object-id (e.g. tuples for document:document-1)
• By object-id and relation (e.g. tuples for 'document:-1' with the 'read' relationship)
• By user id and object-type (e.g. tuples for all documents for user-1)
• By user and object (e.g. tuples for user-1 and document-1
• By user, object, relation (e.g. tuples for user-1 document-1 with read relationship)

However, there are several scenarios where you need more flexibility:

• By object-type (e.g. when deleting a type from the model, I want to delete all tuples for a specific type)
• By object-type and relation (e.g. when deleting a relation from the model, I want to delete all tuples for a specific type)
• By user (e.g. when deleting a user, you want to delete all tuples for a user)
• Filters based on the object_id, e.g. if objects have a structure like permission:{org}/read, I want to filter by org.

[lorenlew]

"The Read API will only return all the stored relationships that match the query specification. It does not expand or traverse the graph by taking the authorization model into account." docs Would it be possible (considered in the design) later taking the authorization model into account?

[aaguiarz]

The goal of the Read API is to read the tuples you've written.

ListObjects / ListRelations (available in the SDKs for now) / ListUsers (in the roadmap) are the endpoints you'd use if you want to query the FGA store taking into account the relations defined in the authorization model.

[krishna-se]

Hi Team, Can we have the feature to fetch data with multiple relationships? Below is the request payload.

{
  "object": "team:x",
  "relation": ["admin", "member"],
}

Here fetch all members and admin of a team x. And the response is like.

{
    "tuples": [
        {
            "key": {
                "user": "user:3",
                "relation": "member",
                "object": "doc:2",
                "condition": null
            },
            "timestamp": "2023-12-11T06:26:04.136575Z"
        },
        {
            "key": {
                "user": "user:38",
                "relation": "admin",
                "object": "doc:2",
                "condition": null
            },
            "timestamp": "2023-12-11T06:36:50.617780Z"
        },
        {
            "key": {
                "user": "user:34",
                "relation": "admin",
                "object": "doc:2",
                "condition": null
            },
            "timestamp": "2023-12-11T06:36:50.630055Z"
        }
}