API Models BatchCheckItemInterface - evansims/openfga-php GitHub Wiki
Represents a single item in a batch check request. Each batch check item contains a tuple key to check, an optional context, optional contextual tuples, and a correlation ID to map the result back to this specific check. The correlation ID must be unique within the batch and follow the pattern: alphanumeric characters or hyphens, maximum 36 characters.
Table of Contents
OpenFGA\Models
ModelInterfaceJsonSerializable
- BatchCheckItem (implementation)
public function getContext(): ?objectGet the context object for this check. This provides additional context data that can be used by conditions in the authorization model during evaluation.
object | null
public function getContextualTuples(): ?OpenFGA\Models\Collections\TupleKeysInterfaceGet the contextual tuples for this check. These are additional tuples that are evaluated only for this specific check and are not persisted in the store.
TupleKeysInterface | null
public function getCorrelationId(): stringGet the correlation ID for this batch check item. This unique identifier maps the result back to this specific check. Must be alphanumeric characters or hyphens, maximum 36 characters.
string — The correlation ID
public function getTupleKey(): TupleKeyInterfaceGet the tuple key to be checked. This defines the user, relation, and object for the authorization check.
TupleKeyInterface — The tuple key for this check
public function jsonSerialize()