API Models UsersetTreeDifference - evansims/openfga-php GitHub Wiki
Represents a difference operation node in authorization evaluation trees. UsersetTreeDifference computes the difference between two nodes in the authorization evaluation tree, effectively calculating "users in base except those in subtract". This enables complex authorization patterns where access is granted to one group while explicitly excluding another. Use this when working with authorization evaluation trees that involve set difference operations.
Table of Contents
OpenFGA\Models
UsersetTreeDifferenceInterfaceJsonSerializableModelInterface
- UsersetTreeDifferenceInterface (interface)
| Name | Value | Description |
|---|---|---|
OPENAPI_MODEL |
UsersetTree.Difference |
public function getBase(): OpenFGA\Models\NodeInterfaceGet the base node from which the subtract node will be removed. This represents the initial node in the userset tree from which users will be subtracted to compute the final difference result.
NodeInterface — The base node for the difference operation
public function getSubtract(): OpenFGA\Models\NodeInterfaceGet the node representing users to subtract from the base. This represents the node in the userset tree whose users should be removed from the base node to compute the final difference result.
NodeInterface — The node to subtract from the base
public function jsonSerialize(): arrayarray
Implements Models\UsersetTreeDifferenceInterface
public function schema(): SchemaInterfaceGet the schema definition for this model. This method returns the schema that defines the structure, validation rules, and serialization behavior for this model class. The schema is used for data validation, transformation, and ensuring consistency across API operations with the OpenFGA service. Each model's schema defines: - Required and optional properties - Data types and format constraints - Nested object relationships - Validation rules and business logic constraints The schema system enables the SDK to automatically validate incoming data, transform between different representations, and ensure compliance with the OpenFGA API specification.
SchemaInterface — The schema definition containing validation rules and property specifications for this model