API Models TupleChange - evansims/openfga-php GitHub Wiki
Represents a change to a relationship tuple in your authorization store. When you modify relationships in OpenFGA (adding or removing tuples), each change is tracked as a TupleChange. This allows you to see the history of authorization changes, audit permissions over time, and understand when relationships were established or removed. Use this when you need to track or review the history of relationship changes in your application, such as for compliance auditing or debugging permission issues.
Table of Contents
OpenFGA\Models
TupleChangeInterfaceJsonSerializableModelInterface
- TupleChangeInterface (interface)
- TupleChanges (collection)
| Name | Value | Description |
|---|---|---|
OPENAPI_MODEL |
TupleChange |
public function getOperation(): OpenFGA\Models\Enums\TupleOperationGet the type of operation performed on the tuple. Operations indicate whether the tuple was written (created) or deleted from the authorization store. This information is crucial for understanding the nature of the change.
TupleOperation — The operation type (write or delete)
public function getTimestamp(): DateTimeImmutableGet the timestamp when this tuple change occurred. Timestamps help track the chronological order of changes and provide audit trail capabilities. They are essential for understanding the sequence of relationship modifications.
DateTimeImmutable — The change timestamp
public function getTupleKey(): OpenFGA\Models\TupleKeyInterfaceGet the tuple key that was affected by this change. The tuple key identifies which specific relationship was created or deleted, containing the user, relation, object, and optional condition information.
TupleKeyInterface — The tuple key that was modified
public function jsonSerialize(): arrayarray
Implements Models\TupleChangeInterface
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