API Requests README

API Documentation > Requests

Request objects for all OpenFGA API operations.

Total Components: 37

Interfaces

Name	Description
BatchCheckRequestInterface	Request for performing multiple authorization checks in a single batch. This request allows check...
CheckRequestInterface	Interface for authorization check request specifications. This interface defines the contract for...
CreateAuthorizationModelRequestInterface	Interface for creating new authorization models in OpenFGA. This interface defines the contract f...
CreateStoreRequestInterface	Interface for creating a new OpenFGA store. This interface defines the contract for requests that...
DeleteStoreRequestInterface	Interface for deleting an OpenFGA store. This interface defines the contract for requests that pe...
ExpandRequestInterface	Interface for expanding relationship graphs in OpenFGA. This interface defines the contract for r...
GetAuthorizationModelRequestInterface	Interface for retrieving a specific authorization model. This interface defines the contract for ...
GetStoreRequestInterface	Interface for retrieving information about an OpenFGA store. This interface defines the contract ...
ListAuthorizationModelsRequestInterface	Interface for listing authorization models in a store. This interface defines the contract for re...
ListObjectsRequestInterface	Interface for listing objects that a user has access to. This interface defines the contract for ...
ListStoresRequestInterface	Interface for listing available OpenFGA stores. This interface defines the contract for requests ...
ListTupleChangesRequestInterface	Interface for listing historical changes to relationship tuples. This interface defines the contr...
ListUsersRequestInterface	Interface for listing users who have a specific relation to an object. This interface defines the...
ReadAssertionsRequestInterface	Interface for reading test assertions from an authorization model. This interface defines the con...
ReadTuplesRequestInterface	Interface for reading relationship tuples from an OpenFGA store. This interface defines the contr...
RequestInterface	Base interface for all OpenFGA API request objects. This interface defines the core contract that...
StreamedListObjectsRequestInterface	Request interface for streaming objects that a user has a specific relationship with. This reques...
WriteAssertionsRequestInterface	Interface for writing test assertions to an authorization model. This interface defines the contr...
WriteTuplesRequestInterface	Interface for writing relationship tuples to an OpenFGA store. This interface defines the contrac...

Classes

Name	Description
BatchCheckRequest	Request for performing multiple authorization checks in a single batch. This request allows check...
CheckRequest	Request for performing authorization checks in OpenFGA. This request determines whether a user ha...
CreateAuthorizationModelRequest	Request for creating a new authorization model in OpenFGA. Authorization models define the permis...
CreateStoreRequest	Request for creating a new OpenFGA store. Stores provide data isolation for different application...
DeleteStoreRequest	Request for permanently deleting a store and all its data. This request removes the entire store,...
ExpandRequest	Request for expanding a relationship to show all users who have that relationship. This request r...
GetAuthorizationModelRequest	Request for retrieving a specific authorization model by its ID. This request fetches the complet...
GetStoreRequest	Request for retrieving store information by its ID. This request fetches the details of a specifi...
ListAuthorizationModelsRequest	Request for listing all authorization models in a store. This request retrieves a paginated list ...
ListObjectsRequest	Request for listing objects that a user has a specific relationship with. This request finds all ...
ListStoresRequest	Request for listing all available stores with pagination support. This request retrieves a pagina...
ListTupleChangesRequest	Request for listing changes to relationship tuples over time. This request retrieves a chronologi...
ListUsersRequest	Request for listing users who have a specific relationship with an object. This request finds all...
ReadAssertionsRequest	Request for reading test assertions associated with an authorization model. This request retrieve...
ReadTuplesRequest	Request for reading relationship tuples that match specified criteria. This request retrieves tup...
StreamedListObjectsRequest	Request for streaming objects that a user has a specific relationship with. This request finds al...
WriteAssertionsRequest	Request for writing test assertions to validate authorization model behavior. This request stores...
WriteTuplesRequest	Request for writing and deleting relationship tuples in OpenFGA. This request enables batch creat...