This repository was archived by the owner on Nov 7, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
API Models Collections README
Evan Sims edited this page Jun 17, 2025
·
7 revisions
API Documentation > Models > Collections
Type-safe collections for managing groups of domain objects.
Total Components: 42
| Name | Description |
|---|---|
AssertionsInterface |
Collection interface for OpenFGA assertion models. This interface defines a collection that holds... |
AuthorizationModelsInterface |
Collection interface for OpenFGA authorization model objects. This interface defines a collection... |
BatchCheckItemsInterface |
Collection of batch check items for batch authorization requests. This collection maintains a lis... |
ComputedsInterface |
|
ConditionParametersInterface |
|
ConditionsInterface |
Collection interface for OpenFGA condition objects. This interface defines a collection that hold... |
IndexedCollectionInterface |
Represents a type-safe collection indexed by integers, similar to a JSON array. This interface pr... |
KeyedCollectionInterface |
Represents a collection that is indexed by a string, like a JSON object. |
NodesInterface |
|
RelationMetadataCollectionInterface |
Collection interface for OpenFGA relation metadata objects. This interface defines a keyed collec... |
RelationReferencesInterface |
|
StoresInterface |
Collection interface for OpenFGA store objects. This interface defines a collection that holds st... |
TupleChangesInterface |
|
TupleKeysInterface |
A collection of relationship tuple keys. This interface represents a type-safe collection of tupl... |
TuplesInterface |
Collection interface for OpenFGA tuple objects. This interface defines a collection that holds tu... |
TypeDefinitionRelationsInterface |
|
TypeDefinitionsInterface |
Collection interface for OpenFGA type definition objects. This interface defines a collection tha... |
UserTypeFiltersInterface |
|
UsersInterface |
Represents a collection of users in authorization contexts. This collection manages users who hav... |
UsersListInterface |
|
UsersetUnionInterface |
Represents a specialized collection for userset union operations. This collection is specifically... |
UsersetsInterface |
Represents a collection of usersets used in authorization model operations. This collection manag... |
| Name | Description |
|---|---|
Assertions |
Collection implementation for OpenFGA assertion models. |
AuthorizationModels |
Collection implementation for OpenFGA authorization model objects. This class provides a concrete... |
BatchCheckItems |
Collection of batch check items for batch authorization requests. This collection maintains a lis... |
Computeds |
|
ConditionParameters |
|
Conditions |
Collection implementation for OpenFGA condition objects. This class provides a concrete implement... |
Nodes |
|
RelationMetadataCollection |
Collection implementation for OpenFGA relation metadata objects. This class provides a concrete i... |
RelationReferences |
|
Stores |
Collection implementation for OpenFGA store objects. This class provides a concrete implementatio... |
TupleChanges |
|
TupleKeys |
Collection implementation for OpenFGA tuple key objects. This class provides a concrete implement... |
Tuples |
Collection implementation for OpenFGA tuple objects. This class provides a concrete implementatio... |
TypeDefinitionRelations |
|
TypeDefinitions |
Collection implementation for OpenFGA type definition objects. This class provides a concrete imp... |
UserTypeFilters |
|
Users |
|
UsersList |
|
UsersetUnion |
|
Usersets |
Getting Started: Introduction • Installation • Authentication
Essentials: Stores • Authorization Models • Relationship Tuples • Permissions Queries
Features: Helper Functions • Concurrency • Results • Exceptions • Observability • Integration
- API Reference - Full class and method documentation
- Quickstart - Get up and running in minutes
- Helpers - Convenient shortcuts for common operations
- Testing Guide - Unit testing with the SDK
- Performance Guide - Optimize for high-scale applications
- Report Issues - Bug reports and feature requests
- Discussions - Community support and questions
- Contributing - Help improve the SDK
- Changelog - Latest updates and releases
- OpenFGA Documentation - Official OpenFGA documentation
- OpenFGA Playground - Interactive modeling environment
- Authorization Concepts - Learn relationship-based access control
- Other SDKs - JavaScript, Go, Python, .NET, and more
OpenFGA PHP SDK • Apache 2.0 License
- Authorization Stores
- Authorization Models
- Relationship Tuples
- Permission Queries
- Testing with Assertions
- Helper Functions
- Concurrency
- Error Handling
- Framework Integration
- OpenTelemetry Observability
- Result Pattern
- Event Dispatcher
- HTTP Request Sent Event
- HTTP Response Received Event
- Operation Started Event
- Operation Completed Event
- More Events …
- Authentication Exception
- Client Exception
- Configuration Exception
- Network Exception
- Serialization Exception
- More Exceptions …
- Request Manager
- Request Context
- Circuit Breaker
- Parallel Task Executor
- Fiber Concurrent Executor
- Simple Concurrent Executor
- Retry Handler
- Exponential Backoff Retry Strategy
- More Networking …