API Models Store - evansims/openfga-php GitHub Wiki
Represents an OpenFGA authorization store that contains your permission data. A Store is a container for all your authorization data - the models, relationships, and permission rules for a specific application or tenant. Each store is isolated from others, allowing you to manage permissions for different applications or environments separately. Think of a store as your application's dedicated permission database that holds all the "who can do what" information for your system.
Table of Contents
OpenFGA\Models
StoreInterfaceJsonSerializableModelInterface
- StoreInterface (interface)
- Stores (collection)
| Name | Value | Description |
|---|---|---|
OPENAPI_MODEL |
Store |
public function getCreatedAt(): DateTimeInterfaceGet the timestamp when the store was created. The creation timestamp provides essential audit information and helps track the lifecycle of authorization stores. This timestamp is set when the store is first created through the OpenFGA API and remains immutable throughout the store's lifetime.
DateTimeInterface — The creation timestamp in UTC timezone
public function getDeletedAt(): ?DateTimeInterfaceGet the timestamp when the store was deleted, if applicable. OpenFGA supports soft deletion of stores, allowing them to be marked as deleted while preserving their data for audit and recovery purposes. When a store is soft-deleted, this timestamp records when the deletion occurred. Active stores will return null for this property.
DateTimeInterface | null — The deletion timestamp in UTC timezone, or null if the store is active
public function getId(): stringGet the unique identifier of the store. The store ID is a globally unique identifier that serves as the primary key for all operations within this authorization context. This ID is used in API requests to target specific stores and ensure isolation between different authorization domains in multi-tenant applications.
string — The store's unique identifier
public function getName(): stringGet the human-readable name of the store. The store name provides a user-friendly identifier for administrative and debugging purposes. Unlike the store ID, names can be changed and are intended to be meaningful to developers and administrators managing authorization systems. Names help identify stores in dashboards, logs, and management interfaces.
string — The store's display name
public function getUpdatedAt(): DateTimeInterfaceGet the timestamp when the store was last updated. The update timestamp tracks when any changes were made to the store's metadata, such as name changes or configuration updates. This timestamp is automatically maintained by the OpenFGA service and provides important audit information for tracking store modifications over time.
DateTimeInterface — The last update timestamp in UTC timezone
public function jsonSerialize(): arraySerialize the store for JSON encoding. This method prepares the store data for API communication, converting all properties into a format compatible with the OpenFGA API specification. Timestamps are converted to RFC3339 format in UTC timezone, ensuring consistent date handling across different systems and timezones. The resulting array contains all store properties with their API-compatible names and values, ready for transmission to the OpenFGA service or storage in JSON format.
array — Store data formatted for JSON encoding with API-compatible field names
Implements Models\StoreInterface
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