API Models Computed - evansims/openfga-php GitHub Wiki
Represents a computed userset reference in authorization evaluation trees. A Computed defines a userset that is calculated based on relationships or other dynamic criteria rather than being explicitly defined. This is used in authorization evaluation trees to represent usersets that are derived through computation during the authorization check process. Use this when working with complex authorization patterns that involve computed or derived user groups.
Table of Contents
OpenFGA\Models
ComputedInterfaceJsonSerializableModelInterface
- ComputedInterface (interface)
- Computeds (collection)
| Name | Value | Description |
|---|---|---|
OPENAPI_MODEL |
Computed |
public function getUserset(): stringGet the userset reference string that defines a computed relationship. This represents a reference to another userset that should be computed dynamically based on relationships. The userset string typically follows the format "#relation" to reference a relation on the same object type.
string — The userset reference string defining the computed relationship
public function jsonSerialize(): arrayarray
Implements Models\ComputedInterface
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