Search
K
FGA-Service

AgentDelegationResponse

object
createdarray[object]
Show Child Parameters
Example

ListObjectsRequest

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

typestringrequired

resource to check against, checking access for policy would be policy

Example:policy

Example

ListObjectsResponse

object
objectsarray[string]

Example:policy:1234

Example

CreatePermissionDto

object
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

Example

RoleDto

object
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

Example