API Responses README - evansims/openfga-php GitHub Wiki

API Documentation > Responses

Response objects containing API results and metadata.

Total Components: 37


Interfaces

Name Description
BatchCheckResponseInterface Response containing the results of a batch authorization check. This response contains a map of c...
CheckResponseInterface Interface for permission check response objects. This interface defines the contract for response...
CreateAuthorizationModelResponseInterface Interface for authorization model creation response objects. This interface defines the contract ...
CreateStoreResponseInterface Interface for store creation response objects. This interface defines the contract for responses ...
DeleteStoreResponseInterface Interface for store deletion response objects. This interface defines the contract for responses ...
ExpandResponseInterface Interface for relationship expansion response objects. This interface defines the contract for re...
GetAuthorizationModelResponseInterface Interface for authorization model retrieval response objects. This interface defines the contract...
GetStoreResponseInterface Interface for store retrieval response objects. This interface defines the contract for responses...
ListAuthorizationModelsResponseInterface Interface for authorization models listing response objects. This interface defines the contract ...
ListObjectsResponseInterface Interface for object listing response objects. This interface defines the contract for responses ...
ListStoresResponseInterface Interface for stores listing response objects. This interface defines the contract for responses ...
ListTupleChangesResponseInterface Interface for tuple changes listing response objects. This interface defines the contract for res...
ListUsersResponseInterface Interface for user listing response objects. This interface defines the contract for responses re...
ReadAssertionsResponseInterface Interface for assertions reading response objects. This interface defines the contract for respon...
ReadTuplesResponseInterface Interface for tuple reading response objects. This interface defines the contract for responses r...
ResponseInterface Base interface for all OpenFGA API response objects. This interface establishes the foundational ...
StreamedListObjectsResponseInterface Response interface for streaming objects that a user has a specific relationship with. This respo...
WriteAssertionsResponseInterface Interface for assertions writing response objects. This interface defines the contract for respon...
WriteTuplesResponseInterface Interface for tuple writing response objects. This interface defines the contract for responses r...


Classes

Name Description
BatchCheckResponse Response containing the results of a batch authorization check. This response contains a map of c...
CheckResponse Response containing the result of an authorization check. This response indicates whether a user ...
CreateAuthorizationModelResponse Response confirming successful creation of a new authorization model. This response provides the ...
CreateStoreResponse Response confirming successful creation of a new store. This response provides the details of the...
DeleteStoreResponse Response confirming successful deletion of a store. This response is returned when a store has be...
ExpandResponse Response containing the expanded userset tree for a relationship query. This response provides a ...
GetAuthorizationModelResponse Response containing a specific authorization model from the store. This response provides the com...
GetStoreResponse Response containing detailed information about a specific store. This response provides comprehen...
ListAuthorizationModelsResponse Response containing a paginated list of authorization models. This response provides access to au...
ListObjectsResponse Response containing a list of objects that a user has a specific relationship with. This response...
ListStoresResponse Response containing a paginated list of available stores. This response provides access to stores...
ListTupleChangesResponse Response containing a paginated list of tuple changes from the store. This response provides a co...
ListUsersResponse Response containing a list of users that have a specific relationship with an object. This respon...
ReadAssertionsResponse Response containing test assertions associated with an authorization model. This response provide...
ReadTuplesResponse Response containing a paginated list of relationship tuples. This response provides access to rel...
StreamedListObjectsResponse Response containing streaming objects that a user has a specific relationship with. This response...
WriteAssertionsResponse Response confirming successful writing of test assertions. This response indicates that test asse...
WriteTuplesResponse Response for tuple writing operations supporting both transactional and non-transactional modes. ...
⚠️ **GitHub.com Fallback** ⚠️