API Models TupleToUsersetV1Interface

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

• Namespace

• Source

• Implements

• Related Classes

• Methods

• getComputedUserset()

  • getTupleset()
  • jsonSerialize()

Namespace

OpenFGA\Models

Source

View source code

Implements

• ModelInterface
• JsonSerializable

Related Classes

• TupleToUsersetV1 (implementation)

Methods

getComputedUserset

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.

View source

Returns

ObjectRelationInterface — The object-relation pair defining the computed userset

getTupleset

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.

View source

Returns

ObjectRelationInterface — The object-relation pair defining the tupleset

jsonSerialize

public function jsonSerialize(): array

View source

Returns

array