API Responses ListObjectsResponse - evansims/openfga-php GitHub Wiki

Response containing a list of objects that a user has a specific relationship with. This response provides an array of object identifiers that the specified user has the given relationship with. Use this to discover what resources a user can access in your authorization system.

OpenFGA\Responses

View source code

• ListObjectsResponseInterface
• ResponseInterface

• ListObjectsResponseInterface (interface)
• ListObjectsRequest (request)

Implements Responses\ListObjectsResponseInterface

public function fromResponse(
    HttpResponseInterface $response,
    HttpRequestInterface $request,
    SchemaValidatorInterface $validator,
): static

Create a response instance from an HTTP response. This method transforms a raw HTTP response from the OpenFGA API into a structured response object, validating and parsing the response data according to the expected schema. It handles both successful responses by parsing and validating the data, and error responses by throwing appropriate exceptions.

View source

static — The parsed and validated response instance containing the API response data

public function getObjects(): array

Get the array of object identifiers the user has access to. Returns an array of object identifiers that the queried user has the specified relationship with. Each string represents an object ID of the requested type that the user can access through the specified relation.

View source

array — Array of object identifiers the user has access to

Implements Responses\ListObjectsResponseInterface

public function schema(): SchemaInterface

Get the schema definition for this response. Returns the schema that defines the structure and validation rules for object listing response data, ensuring consistent parsing and validation of API responses.

View source

SchemaInterface — The schema definition for response validation