Search
K
FGA-Service

Delete Permission

deletes a permission

delete
https://qa.api.zinnia.io/fga/v1/permissions/{permission}

Path Parameters

permissionstringrequired

Response

200
delete/fga/v1/permissions/{permission}
 
200

Update Permission

updates a permission

put
https://qa.api.zinnia.io/fga/v1/permissions/{permission}

Path Parameters

permissionstringrequired

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

200
put/fga/v1/permissions/{permission}

Body

{ "description": "api view access for policy resource", "label": "Read Policy", "permission": "read_policy" }
 
200

Get Permissions for Party

gets permissions for a party

get
https://qa.api.zinnia.io/fga/v1/permissions/party/{partyId}

Path Parameters

partyIdstringrequired

Response

200
get/fga/v1/permissions/party/{partyId}
 
200

Create Role

creates a new role

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

Body

application/json

RoleDto

entitystringrequired

carrier or fga entity

Example:zinnia

entitiesarray[string]required

carriers or fga entities

Example:["elic","sbgc"]

descriptionstringrequired

description of the role

Example:viewer access for sbgc resources

rolestringrequired

fga tuple name

Example:sbgc_viewer

labelstringrequired

role name generally prefixed with carrier or entity descriptive name

Example:Security Benefits Viewer

roleIdstringrequired

unique role id

Example:77fb1e2b-cf96-4a13-8cc6-8645759b0f14

dateCreatedstring(date-time)required

timestamp it occurred

Example:2023-12-06T18:36:35.846Z

queuestringrequired

Queue name associated with the role

Example:withdrawal

Response

201
post/fga/v1/roles

Body

{ "entity": "zinnia", "entities": [ "elic", "sbgc" ], "description": "viewer access for sbgc resources", "role": "sbgc_viewer", "label": "Security Benefits Viewer", "roleId": "77fb1e2b-cf96-4a13-8cc6-8645759b0f14", "dateCreated": "2023-12-06T18:36:35.846Z", "queue": "withdrawal" }
 
201

List Roles

Fetches roles with optional filters for all roles, queue roles, or entity roles.

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

Query Parameters

filterstringrequired
carrierIdstringrequired

Response

200
get/fga/v1/roles
 
200