Search
K
FGA-Service

FGA

List Assertions

List Assertions

get
https://qa.api.zinnia.io/fga/v1/assertions

Response

200 application/json

List of assertions

ReadAssertionsResponse

assertionsarray[object]required
Show Child Parameters
get/fga/v1/assertions
 
200 application/json

Create and update Assertions

Create and update Assertions

post
https://qa.api.zinnia.io/fga/v1/assertions

Body

application/json

WriteAssertionsRequest

assertionsarray[object]required
Show Child Parameters

Response

204

Assertions updated

post/fga/v1/assertions

Body

{ "assertions": [ { "user": "party:495f40f49d8f415fa59e99716d59f6e9", "relation": "read_policy", "object": "policy:1234", "expectation": true } ] }
 
204

Read tuples from OpenFGA

Read tuples from OpenFGA

get
https://qa.api.zinnia.io/fga/v1/tuples

Query Parameters

userstring

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

Example:party:495f40f49d8f415fa59e99716d59f6e9

relationstring

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

Example:read_policy

objectstringrequired

specific resource or resource type to search for, prepended with the type so policy 1234 is policy:1234 and all policies would be policy: with no identifier

Example:policy:1234

pageSizenumber

size of the page

Default:10

<= 100

Example:10

continuationTokenstring

continuation token to provide pagination

Example:eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ

Response

200 application/json

List of tuples

ReadTuplesResponse

tuplesarray[object]
Show Child Parameters
continuation_tokenstring
continuationTokenstring
get/fga/v1/tuples
 
200 application/json

Write tuples to OpenFGA

Write tuples to OpenFGA

post
https://qa.api.zinnia.io/fga/v1/tuples

Body

application/json

WriteTuplesRequest

tuplesarray[object]required
Show Child Parameters
disableTransactionboolean

Response

201 application/json

Tuples updated

WriteTuplesResponse

createdarray[object]
Show Child Parameters
post/fga/v1/tuples

Body

{ "tuples": [ { "user": "party:495f40f49d8f415fa59e99716d59f6e9", "relation": "read_policy", "object": "policy:1234" } ] }
 
201 application/json