API Responses BatchCheckResponseInterface - evansims/openfga-php GitHub Wiki

Response containing the results of a batch authorization check. This response contains a map of correlation IDs to check results, allowing you to match each result back to the original check request using the correlation ID that was provided in the batch request.

Table of Contents


Namespace

OpenFGA\Responses


Source

View source code


Implements


Related Classes


Methods

getResult

public function getResult(): array<string, BatchCheckSingleResultInterface>

Get the results map from correlation IDs to check results. Each key in the map is a correlation ID from the original request, and each value is the result of that specific check.

View source


Returns

array&lt;string, [BatchCheckSingleResultInterface](Models-BatchCheckSingleResultInterface)&gt; — Map of correlation ID to check result


getResultForCorrelationId

public function getResultForCorrelationId(string $correlationId): ?OpenFGA\Models\BatchCheckSingleResultInterface

Get the result for a specific correlation ID. Returns the check result for the given correlation ID, or null if no result exists for that ID.

View source


Parameters

Name Type Description
$correlationId string The correlation ID to look up

Returns

BatchCheckSingleResultInterface | null

⚠️ **GitHub.com Fallback** ⚠️