API Models BatchCheckItemInterface

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

• Namespace

• Source

• Implements

• Related Classes

• Methods

• getContext()

  • getContextualTuples()
  • getCorrelationId()
  • getTupleKey()
  • jsonSerialize()

Namespace

OpenFGA\Models

Source

View source code

Implements

• ModelInterface
• JsonSerializable

Related Classes

• BatchCheckItem (implementation)

Methods

getContext

public function getContext(): ?object

Get the context object for this check. This provides additional context data that can be used by conditions in the authorization model during evaluation.

View source

Returns

object | null

getContextualTuples

public function getContextualTuples(): ?OpenFGA\Models\Collections\TupleKeysInterface

Get 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.

View source

Returns

TupleKeysInterface | null

getCorrelationId

public function getCorrelationId(): string

Get 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.

View source

Returns

string — The correlation ID

getTupleKey

public function getTupleKey(): TupleKeyInterface

Get the tuple key to be checked. This defines the user, relation, and object for the authorization check.

View source

Returns

TupleKeyInterface — The tuple key for this check

jsonSerialize

public function jsonSerialize()