IF Commons GitHub

sql/typed/models/identity-rebac.auto

The typed tables of the identityRebac model, generated by IFC Data from the model. Do not edit: change the model and run bun tools/typed.ts --write.

Relationship-based access

Source: commons/data/sql/typed/models/identity-rebac.auto.ts

0 of 12 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

identityRebacnamespace
namespace identityRebac
identityRebac.AuthorizationModelRowinterfaceno test imports it
interface AuthorizationModelRow

The definition of a relationship-based access model: its object types, relations, rewrites and caveats

MemberTypeWhat it is
authorizationModelIdstringWhat identifies the model, made by the application
versionnumberWhich version of the model this is
definitionunknownThe types, relations, rewrites and caveats
status"active" | "retired"Whether it is in use
tenantIdstring | nullThe tenant it is for; empty for the platform's
identityRebac.AuthorizationModelInsertinterfaceno test imports it
interface AuthorizationModelInsert

What an insert into authorization_model takes: what the database fills may be left out.

MemberTypeWhat it is
authorizationModelIdstring
versionnumber
definitionunknown
status"active" | "retired"
tenantId?string | null
identityRebac.AuthorizationModelKeytypeno test imports it
type AuthorizationModelKey = { readonly authorizationModelId: string };

The key of a row of authorization_model.

identityRebac.authorizationModelconstno test imports it
const authorizationModel: Table<AuthorizationModelRow, AuthorizationModelInsert, "authorizationModel">

The definition of a relationship-based access model: its object types, relations, rewrites and caveats

identityRebac.RelationTupleRowinterfaceno test imports it
interface RelationTupleRow

A fact of relationship-based access: this subject has this relation to this object, perhaps under a caveat and until a time

MemberTypeWhat it is
relationTupleIdstringWhat identifies the fact, made by the application
tupleKeystringA hash of the tenant, the object, the relation and the subject, unique, so that a fact is not recorded twice
objectTypestringThe kind of the object
objectIdstringThe object
relationstringThe relation
subjectTypestringThe kind of the subject: a kind of principal, or a kind of object
subjectIdstringThe subject
subjectRelationstring | nullThe relation of the subject that is meant, where a set is
caveatstring | nullThe name of a caveat of the model that must hold
caveatContextunknownThe values the caveat is given
expiresAtTimestamp | nullWhen the fact stops holding
createdAtTimestampWhen the fact was recorded
tenantIdstringThe tenant the fact is in
identityRebac.RelationTupleInsertinterfaceno test imports it
interface RelationTupleInsert

What an insert into relation_tuple takes: what the database fills may be left out.

MemberTypeWhat it is
relationTupleIdstring
tupleKeystring
objectTypestring
objectIdstring
relationstring
subjectTypestring
subjectIdstring
subjectRelation?string | null
caveat?string | null
caveatContext?unknown
expiresAt?Timestamp | null
createdAtTimestamp
tenantIdstring
identityRebac.RelationTupleKeytypeno test imports it
type RelationTupleKey = { readonly relationTupleId: string };

The key of a row of relation_tuple.

identityRebac.relationTupleconstno test imports it
const relationTuple: Table<RelationTupleRow, RelationTupleInsert, "relationTuple">

A fact of relationship-based access: this subject has this relation to this object, perhaps under a caveat and until a time

identityRebac.PermissionRelationRowinterfaceno test imports it
interface PermissionRelationRow

What holding a relation on an object of a type grants: the join between relationships and the permissions every kind of access shares

MemberTypeWhat it is
permissionIdstringThe permission granted
objectTypestringThe kind of object
relationstringThe relation that grants the permission
identityRebac.PermissionRelationInsertinterfaceno test imports it
interface PermissionRelationInsert

What an insert into permission_relation takes: what the database fills may be left out.

MemberTypeWhat it is
permissionIdstring
objectTypestring
relationstring
identityRebac.PermissionRelationKeytypeno test imports it
type PermissionRelationKey = { readonly permissionId: string; readonly objectType: string };

The key of a row of permission_relation.

identityRebac.permissionRelationconstno test imports it
const permissionRelation: Table<PermissionRelationRow, PermissionRelationInsert, "permissionRelation">

What holding a relation on an object of a type grants: the join between relationships and the permissions every kind of access shares

Titles, headings, exports, tables, columns and requirements. Esc closes.