rolestringrequired
permissionstringrequired
Add Permission to Role
adds a permission to a role
post
https://qa.api.zinnia.io/fga/v1/roles/{role}/permissions/{permission}
Path Parameters
Response
201
Response
201
post/fga/v1/roles/{role}/permissions/{permission}
Authentication
Path Parameters
201
Remove Permission from Role
removes a permission from a role
delete
https://qa.api.zinnia.io/fga/v1/roles/{role}/permissions/{permission}
Path Parameters
rolestringrequired
permissionstringrequired
Response
200
Response
200
delete/fga/v1/roles/{role}/permissions/{permission}
Authentication
Path Parameters
200
Create Ops Tuple
Create Ops Tuple
post
https://qa.api.zinnia.io/fga/v1/ops-tuples/create
Body
application/json
Body
application/json
CreateOpsRequest
emailstringrequired
Authentication user email address
Example:ciam@zinnia.com
carrierCodestringrequired
Carrier id to provide access
Allowed values:allmallsariccwadlicelicemrsflicgdmnglacglcogiliilicilnajhlimassmwoanasunlidnlvfpicaplicpmhcprdnprudrslnsaagsbgcsbulsmtruliculpcusaawelbpgzinniasblfnwlevglnylawsfgprdlpclfglblsamcwnlc
rolestringrequired
Access type to provide
Allowed values:processorviewercall_centerillustrator
Response
201
Response
201
Tuple created
post/fga/v1/ops-tuples/create
Authentication
Body
{
"email": "ciam@zinnia.com",
"carrierCode": "allm",
"role": "processor"
}
201
Delete Ops Tuple
Delete Ops Tuple
post
https://qa.api.zinnia.io/fga/v1/ops-tuples/delete
Body
application/json
Body
application/json
DeleteOpsRequest
emailstringrequired
Authentication user email address
Example:ciam@zinnia.com
carrierCodestringrequired
Carrier id to provide access
Allowed values:allmallsariccwadlicelicemrsflicgdmnglacglcogiliilicilnajhlimassmwoanasunlidnlvfpicaplicpmhcprdnprudrslnsaagsbgcsbulsmtruliculpcusaawelbpgzinniasblfnwlevglnylawsfgprdlpclfglblsamcwnlc
rolestringrequired
Access type to provide
Allowed values:processorviewercall_centerillustrator
Response
204
Response
204
Tuple deleted
post/fga/v1/ops-tuples/delete
Authentication
Body
{
"email": "ciam@zinnia.com",
"carrierCode": "allm",
"role": "processor"
}
204
Search for related cases and policies for a party
Searches and retrieves all related cases and/or policies for a given party ID
get
https://qa.api.zinnia.io/fga/v1/search-parties
Query Parameters
partyIdstringrequired
ID of the party to get related data for
filterTypestring
Filter to show only policies or cases related data
Allowed values:policiescases
maxDepthnumber
Maximum depth for recursive relationship fetching. Leave empty for unlimited depth.
excludeSourcestring
Exclude either entity or salesentity data sources from the results
Allowed values:entitysalesentity
directOnlyboolean
Return only direct party relationships. For policies: return direct party policies only. For cases: return direct party cases plus cases from direct party policies.
Response
application/json
Response
application/json
Successfully retrieved related data
PartyRelatedDataResponse
partyIdstringrequired
party id for which related data is being retrieved
casesarray[string]
List of related case IDs
policiesarray[object]
List of related policies
Show Child Parameters
get/fga/v1/search-parties
Query Parameters
application/json