Skip to main content

getRelationshipTuples

Function getRelationshipTuples in pulumi-openfga.
2 min read

Function getRelationshipTuples in pulumi-openfga.

Invoke token: openfga:index/getRelationshipTuples:getRelationshipTuples.

Example#

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

getRelationshipTuplesOutput accepts Input values and returns Output of the same result.

Arguments#

PropertyTypeRequiredDescription
queryGetRelationshipTuplesQuery (input)no
storeIdstringyes

Result#

PropertyTypeAlways presentDescription
queryGetRelationshipTuplesQuery (output)no
relationshipTuplesGetRelationshipTuplesRelationshipTuple[]yes
storeIdstringyes

GetRelationshipTuplesQuery (input)#

Input object GetRelationshipTuplesQuery. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
objectstringyesThe object of the resulting relationship tuples.
relationstringnoThe relation of the resulting relationship tuples.
userstringnoThe user of the resulting relationship tuples.

GetRelationshipTuplesQuery (output)#

Output object GetRelationshipTuplesQuery. Fields below belong to this object.

PropertyTypeAlways presentDescription
objectstringyesThe object of the resulting relationship tuples.
relationstringnoThe relation of the resulting relationship tuples.
userstringnoThe user of the resulting relationship tuples.

GetRelationshipTuplesRelationshipTuple#

Output object GetRelationshipTuplesRelationshipTuple. Fields below belong to this object.

PropertyTypeAlways presentDescription
conditionGetRelationshipTuplesRelationshipTupleConditionyesA condition of the relationship tuple.
objectstringyesThe object of the relationship tuple.
relationstringyesThe relation of the relationship tuple.
userstringyesThe user of the relationship tuple.

GetRelationshipTuplesRelationshipTupleCondition#

Output object GetRelationshipTuplesRelationshipTupleCondition. Fields below belong to this object.

PropertyTypeAlways presentDescription
contextJsonstringyesThe (partial) context under which the condition is evaluated.
namestringyesThe name of the condition.