API Requests ExpandRequest

Request for expanding a relationship to show all users who have that relationship. This request returns the complete set of users and usersets that have the specified relationship with an object. It's useful for debugging authorization models, auditing permissions, and understanding the complete authorization tree.

Table of Contents

• Namespace

• Source

• Implements

• Related Classes

• Methods

• getConsistency()

  • getContextualTuples()
  • getModel()
  • getRequest()
  • getStore()
  • getTupleKey()

Namespace

OpenFGA\Requests

Source

View source code

Implements

• ExpandRequestInterface
• RequestInterface

Related Classes

• ExpandResponse (response)
• ExpandRequestInterface (interface)

Methods

getConsistency

public function getConsistency(): ?OpenFGA\Models\Enums\Consistency

Get the read consistency level for the expand operation. Determines the consistency guarantees for reading authorization data during the expansion. This allows you to balance between read performance and data freshness based on your application's requirements.

View source

Returns

Consistency | null — The consistency level for the operation, or null to use the default consistency setting

getContextualTuples

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

Get additional tuples to consider during the expansion. Returns a collection of temporary relationship tuples that are added to the authorization data during evaluation. This allows you to test how hypothetical or pending relationship changes would affect the authorization graph without permanently modifying the store.

View source

Returns

TupleKeysInterface | null — Additional relationship tuples for evaluation, or null if none provided

getModel

public function getModel(): ?string

Get the authorization model ID to use for the expansion. Specifies which version of the authorization model should be used when expanding the relationship graph. Using a specific model ID ensures consistent results even when the model is being updated. If not specified, the latest model version will be used.

View source

Returns

string | null — The authorization model ID for evaluation, or null to use the latest model version

getRequest

public function getRequest(Psr\Http\Message\StreamFactoryInterface $streamFactory): OpenFGA\Network\RequestContext

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

View source

Parameters

Name	Type	Description
$streamFactory	StreamFactoryInterface	PSR-7 stream factory for creating request body streams from serialized data

Returns

RequestContext — The prepared request context containing HTTP method, URL, headers, and body ready for execution

getStore

public function getStore(): string

Get the store ID containing the authorization data. Identifies which OpenFGA store contains the relationship tuples and configuration to use for the expansion. All evaluation will be performed within the context of this specific store.

View source

Returns

string — The store ID containing the authorization data

getTupleKey

public function getTupleKey(): OpenFGA\Models\TupleKeyInterface

Get the relationship tuple to expand. Specifies the starting point for the relationship expansion. This defines the object and relation for which the authorization graph should be expanded. The expansion will show all users and user sets that have the specified relation to the specified object.

View source

Returns

TupleKeyInterface — The relationship tuple specifying what to expand (object and relation)