Search
K
FGA-Service

CheckTupleResponse

object
userstringrequired

party reference Id prefixed with party, so 495f40f49d8f415fa59e99716d59f6e9 is party:495f40f49d8f415fa59e99716d59f6e9

Example:party:495f40f49d8f415fa59e99716d59f6e9

relationstringrequired

the permission or relation for the resource, usually described by access + _ + resource example: read_policy

Example:read_policy

objectstringrequired

specific resource, prepended with the type so policy 1234 is policy:1234

Example:policy:1234

allowedbooleanrequired
Example

BulkCheckResponse

object
tuplesarray[object]required
Show Child Parameters
Example

CheckRequestWithConsistency

object
userstringrequired

party reference Id prefixed with party, so 495f40f49d8f415fa59e99716d59f6e9 is party:495f40f49d8f415fa59e99716d59f6e9

Example:party:495f40f49d8f415fa59e99716d59f6e9

relationstringrequired

the permission to check on the resource, usually described by access + _ + resource example: read_policy

Example:read_policy

objectstringrequired

specific resource to check against, prepended with the type so policy 1234 is policy:1234

Example:policy:1234

consistencystring

Consistency preference for the check. UNSPECIFIED (default) for eventual consistency, MINIMIZE_LATENCY for faster responses, HIGHER_CONSISTENCY for stronger consistency guarantees.

Allowed values:UNSPECIFIEDMINIMIZE_LATENCYHIGHER_CONSISTENCY

Default:UNSPECIFIED

Example

CheckResponse

object
allowedbooleanrequired
Example

ParentCheckRequest

object
userstringrequired

party reference Id prefixed with party, so 495f40f49d8f415fa59e99716d59f6e9 is party:495f40f49d8f415fa59e99716d59f6e9

Example:party:495f40f49d8f415fa59e99716d59f6e9

relationstringrequired

the permission to check on the resource, usually described by access + _ + resource example: read_policy

Example:read_policy

objectstringrequired

specific resource to check against, prepended with the type so policy 1234 is policy:1234

Example:policy:1234

parentObjectstringrequired

parent object to check relation to, for example plancode:1234 for policy:1234 to verify the policy is also part of the plancode

Example:plancode:1234

Example