Interface: ListAuthzTuplesQuery
@kortexya/reasoninglayer / ListAuthzTuplesQuery
Interface: ListAuthzTuplesQuery
Section titled “Interface: ListAuthzTuplesQuery”Defined in: src/types/authz.ts:236
Filters for GET /api/v1/authz/tuples.
Remarks
Section titled “Remarks”relation selects the sort to list (default can). Every other field is
a leg filter — string equality against that leg’s rendered value — and
several filters are ANDed. The keys are sent as query parameters verbatim.
Example
Section titled “Example”const query: ListAuthzTuplesQuery = { relation: 'can', subject: 'user:alice' };Properties
Section titled “Properties”permission?
Section titled “permission?”
optionalpermission?:string
Defined in: src/types/authz.ts:242
Keep the tuples whose permission leg equals this.
relation?
Section titled “relation?”
optionalrelation?:AuthzRelation
Defined in: src/types/authz.ts:238
The relation to list. Default can.
resource?
Section titled “resource?”
optionalresource?:string
Defined in: src/types/authz.ts:244
Keep the tuples whose resource leg equals this.
optionalrole?:string
Defined in: src/types/authz.ts:246
Keep the tuples whose role leg equals this.
subject?
Section titled “subject?”
optionalsubject?:string
Defined in: src/types/authz.ts:240
Keep the tuples whose subject leg equals this.
optionalwhen?:string
Defined in: src/types/authz.ts:248
Keep the tuples whose when leg equals this.