API Models README - evansims/openfga-php GitHub Wiki
API Documentation > Models
Domain models representing OpenFGA entities like stores, tuples, and authorization models.
Total Components: 73
| Directory | Description |
|---|---|
Collections |
Type-safe collections for managing groups of domain objects. |
Enums |
Enumeration types for consistent value constraints across the SDK. |
| Name | Description |
|---|---|
AssertionInterface |
Represents an assertion used to test authorization model correctness. Assertions are test cases t... |
AssertionTupleKeyInterface |
Defines the contract for assertion tuple keys used in authorization model testing. An assertion t... |
AuthorizationModelInterface |
Represents an OpenFGA authorization model that defines permission structures. Authorization model... |
BatchCheckItemInterface |
Represents a single item in a batch check request. Each batch check item contains a tuple key to ... |
BatchCheckSingleResultInterface |
Represents the result of a single check within a batch check response. Each result contains wheth... |
BatchTupleOperationInterface |
Interface for batch tuple operations. Defines the contract for organizing tuple writes and delete... |
BatchTupleResultInterface |
Interface for batch tuple operation results. Defines the contract for tracking and analyzing the ... |
ComputedInterface |
Represents a computed userset in OpenFGA authorization models. Computed usersets allow you to def... |
ConditionInterface |
Represents a condition that enables dynamic authorization in OpenFGA. Conditions allow OpenFGA to... |
ConditionMetadataInterface |
Defines metadata information for conditions in OpenFGA authorization models. ConditionMetadata pr... |
ConditionParameterInterface |
Defines a parameter type for use in authorization conditions. ConditionParameter represents the t... |
DifferenceV1Interface |
Defines a difference operation between two usersets in authorization models. DifferenceV1 represe... |
LeafInterface |
Represents a leaf node in OpenFGA's userset tree structure. Leaf nodes are terminal nodes in the ... |
MetadataInterface |
Represents metadata associated with OpenFGA authorization model components. Metadata provides add... |
ModelInterface |
Base interface for all OpenFGA model objects. This interface establishes the foundation for all d... |
NodeInterface |
Represents a node in a userset tree structure. Nodes are fundamental building blocks in OpenFGA's... |
NodeUnionInterface |
Represents a union operation between multiple nodes in a userset tree. A node union combines mult... |
ObjectRelationInterface |
Represents an object-relation pair in OpenFGA authorization models. Object-relation pairs are fun... |
RelationMetadataInterface |
Represents metadata associated with a relation in OpenFGA authorization models. Relation metadata... |
RelationReferenceInterface |
Defines the contract for relation references with optional conditions. A relation reference speci... |
SourceInfoInterface |
Represents source file information for OpenFGA model elements. Source information provides debugg... |
StoreInterface |
Represents an OpenFGA store that contains authorization models and relationship tuples. A store i... |
TupleChangeInterface |
Represents a change event for a relationship tuple in OpenFGA. Tuple changes capture the history ... |
TupleInterface |
Represents a relationship tuple in the OpenFGA authorization system. Tuples are the fundamental b... |
TupleKeyInterface |
Represents a tuple key that defines the components of a relationship in OpenFGA. Tuple keys are t... |
TupleToUsersetV1Interface |
Defines a tuple-to-userset operation in authorization models. TupleToUsersetV1 represents an auth... |
TypeDefinitionInterface |
Represents a type definition in an OpenFGA authorization model. Type definitions are the building... |
TypedWildcardInterface |
Defines the contract for typed wildcard specifications. A typed wildcard represents "all users of... |
UserInterface |
Represents a user in an OpenFGA authorization model. In OpenFGA, users are flexible entities that... |
UserObjectInterface |
Represents a user object in OpenFGA authorization model. User objects are typed entities that can... |
UserTypeFilterInterface |
Represents a filter for limiting users by their relationships to specific object types. User type... |
UsersListUserInterface |
Represents a user in a list context for authorization operations. UsersListUser provides a simple... |
UsersetInterface |
Defines the contract for userset specifications in authorization models. A userset represents a c... |
UsersetTreeDifferenceInterface |
Defines a difference operation node in authorization evaluation trees. UsersetTreeDifference repr... |
UsersetTreeInterface |
Defines a tree structure for representing complex userset operations. UsersetTree provides a hier... |
UsersetTreeTupleToUsersetInterface |
Defines a tuple-to-userset operation node in authorization evaluation trees. UsersetTreeTupleToUs... |
UsersetUserInterface |
Defines the contract for userset user specifications. A userset user represents a reference to us... |
| Name | Description |
|---|---|
Assertion |
Tests whether your authorization model behaves correctly for specific scenarios. Assertions are t... |
AssertionTupleKey |
Represents a tuple key used for testing authorization model assertions. An AssertionTupleKey defi... |
AuthorizationModel |
Defines the authorization rules and relationships for your application. An AuthorizationModel is ... |
BatchCheckItem |
Represents a single item in a batch check request. Each batch check item contains a tuple key to ... |
BatchCheckSingleResult |
Represents the result of a single check within a batch check response. Each result contains wheth... |
BatchTupleOperation |
Represents a batch tuple operation containing both writes and deletes. This model organizes tuple... |
BatchTupleResult |
Represents the result of a batch tuple operation. This model tracks the results of processing a b... |
Computed |
Represents a computed userset reference in authorization evaluation trees. A Computed defines a u... |
Condition |
Represents an ABAC (Attribute-Based Access Control) condition in your authorization model. A Cond... |
ConditionMetadata |
Contains metadata information about conditions in your authorization model. ConditionMetadata pro... |
ConditionParameter |
Represents a parameter type definition for ABAC conditions. ConditionParameter defines the type s... |
DifferenceV1 |
Represents a set difference operation between two usersets. In authorization models, you sometime... |
Leaf |
Represents a leaf node in authorization evaluation trees containing specific users. A Leaf is a t... |
Metadata |
Contains metadata information about type definitions in your authorization model. Metadata provid... |
Node |
Represents a node in the authorization evaluation tree structure. When OpenFGA evaluates complex ... |
NodeUnion |
Represents a union of multiple nodes in an authorization model tree. When OpenFGA evaluates compl... |
ObjectRelation |
Represents a reference to a specific relation on an object. In authorization models, you often ne... |
RelationMetadata |
Contains metadata information about a relation in your authorization model. RelationMetadata prov... |
RelationReference |
Represents a reference to a specific relation with optional conditions. A RelationReference ident... |
SourceInfo |
Represents source file information for debugging and development tools. SourceInfo provides metad... |
Store |
Represents an OpenFGA authorization store that contains your permission data. A Store is a contai... |
Tuple |
Represents a stored relationship tuple in your authorization system. A Tuple is a relationship re... |
TupleChange |
Represents a change to a relationship tuple in your authorization store. When you modify relation... |
TupleKey |
Represents a relationship tuple key defining a connection between user, relation, and object. A T... |
TupleToUsersetV1 |
Represents a tuple-to-userset relationship that derives permissions from related objects. This en... |
TypeDefinition |
Represents a type definition in your authorization model. A TypeDefinition defines an object type... |
TypedWildcard |
Represents a wildcard that matches all users of a specific type. In authorization models, you som... |
User |
Represents a user or user specification in authorization contexts. A User can represent different... |
UserObject |
Represents a specific user object with type and identifier. A UserObject provides a structured wa... |
UserTypeFilter |
Represents a filter for limiting users by type and optional relation. UserTypeFilter allows you t... |
UsersListUser |
Represents a user entry in a users list response. UsersListUser provides a simple wrapper around ... |
Userset |
Represents a userset specification for computing groups of users. A Userset defines how to comput... |
UsersetTree |
Represents the evaluation tree for determining user access. When OpenFGA evaluates whether a user... |
UsersetTreeDifference |
Represents a difference operation node in authorization evaluation trees. UsersetTreeDifference c... |
UsersetTreeTupleToUserset |
Represents a tuple-to-userset operation node in authorization evaluation trees. UsersetTreeTupleT... |
UsersetUser |
Represents a user reference through a userset relationship. UsersetUser defines a user specificat... |