API Models UsersetUserInterface - evansims/openfga-php GitHub Wiki

Defines the contract for userset user specifications. A userset user represents a reference to users through a userset relationship, typically in the format "object#relation" where object is the entity and relation defines which users are included. This allows dynamic user groups based on relationships rather than static user lists. Use this when you need to reference users through relationship-based groups in your authorization model.

OpenFGA\Models

View source code

• ModelInterface
• JsonSerializable

• UsersetUser (implementation)

public function getId(): string

Get the object identifier in the userset reference. This represents the specific object instance that the userset refers to. For example, in "group:eng#member," this would return "eng."

View source

string — The object identifier

public function getRelation(): string

Get the relation name in the userset reference. This represents the specific relation on the referenced object that defines the userset. For example, in "group:eng#member," this would return "member."

View source

string — The relation name

public function getType(): string

Get the object type in the userset reference. This represents the type of object that the userset refers to. For example, in "group:eng#member," this would return "group."

View source

string — The object type

public function jsonSerialize(): array

View source

array