ListQueueRequest
userstringrequired
Example:party:b6eeddafdd9e4f92aecf84f6b6702442
relationstringrequired
Example:read_policy
Return queues a user has access to
This endpoint retrieves the queues that a specified user has access to based on the provided relation.
post
https://qa.api.zinnia.io/fga/v1/list-queue
Body
application/json
Body
application/json
Response
200 application/json
Response
200 application/json
OK
ListQueueResponse
queuesarray[object]required
Example:[{"sbgc":["withdrawal","deposit"]},{"mass":["suitability","claims"]}]
post/fga/v1/list-queue
Authentication
Body
{
"user": "party:b6eeddafdd9e4f92aecf84f6b6702442",
"relation": "read_policy"
}
200 application/json
Delegate access to an assistant
Allows an agent to delegate their access to an assistant agent, except for super admin roles.
post
https://qa.api.zinnia.io/fga/v1/access/delegation/{assistantId}
Path Parameters
assistantIdstringrequired
ID of the assistant to delegate permissions to
Response
200 application/json
Response
200 application/json
Delegation successful
AgentDelegationResponse
createdarray[object]
Show Child Parameters
post/fga/v1/access/delegation/{assistantId}
Authentication
Path Parameters
200 application/json
List all objects in relation with the user
List all objects in relation with the user
post
https://qa.api.zinnia.io/fga/v1/list
Body
application/json
Body
application/json
ListObjectsRequest
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
typestringrequired
resource to check against, checking access for policy would be policy
Example:policy
Response
200 application/json
Response
200 application/json
OK
ListObjectsResponse
objectsarray[string]
Example:["policy:1234"]
post/fga/v1/list
Authentication
Body
{
"user": "party:495f40f49d8f415fa59e99716d59f6e9",
"relation": "read_policy",
"type": "policy"
}
200 application/json
Get All Available Permissions
gets all permissions
get
https://qa.api.zinnia.io/fga/v1/permissions
Response
200
Response
200
get/fga/v1/permissions
Authentication
200
Create Permission
creates a new permission
post
https://qa.api.zinnia.io/fga/v1/permissions
Body
application/json
Body
application/json
CreatePermissionDto
descriptionstringrequired
description of the permission
Example:api view access for policy resource
labelstringrequired
permission descriptive name
Example:Read Policy
permissionstringrequired
fga tuple id name
Example:read_policy
dateCreatedstring(date-time)
timestamp it occured
Example:2023-12-06T18:36:35.846Z
Response
201
Response
201
post/fga/v1/permissions
Authentication
Body
{
"description": "api view access for policy resource",
"label": "Read Policy",
"permission": "read_policy"
}
201