API Models TupleToUsersetV1Interface - evansims/openfga-php GitHub Wiki
Defines a tuple-to-userset operation in authorization models. TupleToUsersetV1 represents an authorization operation that computes usersets by following relationships from one object type to usersets on related objects. This enables complex authorization patterns like "users who can view a document are the editors of the parent folder" or "viewers of a resource are the members of the associated organization". Use this interface when implementing authorization models that involve indirect relationships through tuple-to-userset operations.
Table of Contents
OpenFGA\Models
ModelInterface
JsonSerializable
- TupleToUsersetV1 (implementation)
public function getComputedUserset(): ObjectRelationInterface
Get the userset that will be computed based on the tupleset. This represents the object-relation pair that defines which userset should be computed for each tuple found in the tupleset. The computed userset determines the final set of users resulting from the tuple-to-userset operation.
ObjectRelationInterface
— The object-relation pair defining the computed userset
public function getTupleset(): ObjectRelationInterface
Get the tupleset (object-relation pair) that defines which tuples to use for computation. This represents the object-relation pair that identifies which tuples should be examined to compute the final userset. For each matching tuple, the computed userset will be evaluated to determine the resulting users.
ObjectRelationInterface
— The object-relation pair defining the tupleset
public function jsonSerialize(): array
array