Interface: AuthzTuple
@kortexya/reasoninglayer / AuthzTuple
Interface: AuthzTuple
Section titled “Interface: AuthzTuple”Defined in: src/types/authz.ts:196
An authorization tuple as stored.
Remarks
Section titled “Remarks”Returned by POST /api/v1/authz/tuples and GET /api/v1/authz/tuples.
Properties
Section titled “Properties”
optionaletag?:string
Defined in: src/types/authz.ts:220
The tuple’s entity tag, from the ETag header of
AuthzClient.writeTuple’s answer.
Remarks
Section titled “Remarks”Pass it to deleteTuple(id, { ifMatch }) to revoke the tuple only if
nobody rewrote it since. Not part of the response body, and absent on a
listed tuple.
features
Section titled “features”features: [
string,string][]
Defined in: src/types/authz.ts:210
Every feature leg as a [name, value] pair — subject, then
permission / resource or role, and when when set.
Remarks
Section titled “Remarks”The order is not stable across reads; look a leg up by name.
id:
string
Defined in: src/types/authz.ts:198
Content-addressed tuple (term) id — the same for the same tuple content.
relation
Section titled “relation”relation:
string
Defined in: src/types/authz.ts:200
can or has_role. Typed string so a relation a newer engine adds is not lost.
subject
Section titled “subject”subject:
string
Defined in: src/types/authz.ts:202
The subject leg, extracted for convenience.