API Requests BatchCheckRequestInterface - evansims/openfga-php GitHub Wiki
Request for performing multiple authorization checks in a single batch. This request allows checking multiple user-object relationships simultaneously for better performance when multiple authorization decisions are needed. Each check in the batch has a correlation ID to map results back to the original requests. The batch check operation supports the same features as individual checks: contextual tuples, custom contexts, and detailed error information.
Table of Contents
OpenFGA\Requests
- BatchCheckResponseInterface (response)
- BatchCheckRequest (implementation)
public function getChecks(): BatchCheckItemsInterfaceGet the collection of checks to perform in this batch. Each item contains a tuple key to check and a correlation ID to map the result back to this specific check.
BatchCheckItemsInterface — The batch check items
public function getRequest(StreamFactoryInterface $streamFactory): RequestContextBuild a request context for HTTP execution. Transforms the request object into a standardized HTTP request context that can be executed by the OpenFGA HTTP client. This method handles all aspects of request preparation including parameter serialization, URL construction, header configuration, and body stream creation. The method validates that all required parameters are present and properly formatted, serializes complex objects to JSON, constructs the appropriate API endpoint URL, and creates the necessary HTTP message body streams.
| Name | Type | Description |
|---|---|---|
$streamFactory |
StreamFactoryInterface |
PSR-7 stream factory for creating request body streams from serialized data |
RequestContext — The prepared request context containing HTTP method, URL, headers, and body ready for execution