IF Commons GitHub

sql/typed/models/identity-abac.auto

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

Attribute-based access for every kind of principal

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

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

identityAbacnamespace
namespace identityAbac
identityAbac.ExpressionLanguageRowinterfaceno test imports it
interface ExpressionLanguageRow

The language a condition is written in

MemberTypeWhat it is
codestringThe code other tables point to: a short word that does not change
labelstringWhat a person is shown for the code
descriptionstring | nullWhat the code means, where the label is not enough
identityAbac.ExpressionLanguageInsertinterfaceno test imports it
interface ExpressionLanguageInsert

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

MemberTypeWhat it is
codestring
labelstring
description?string | null
identityAbac.ExpressionLanguageKeytypeno test imports it
type ExpressionLanguageKey = { readonly code: string };

The key of a row of expression_language.

identityAbac.expressionLanguageconstno test imports it
const expressionLanguage: Table<ExpressionLanguageRow, ExpressionLanguageInsert, "expressionLanguage">

The language a condition is written in

identityAbac.AttributeDefinitionRowinterfaceno test imports it
interface AttributeDefinitionRow

An attribute that decisions may use, with its type, where its values come from and how old they may be

MemberTypeWhat it is
attributeDefinitionIdstringWhat identifies the attribute, made by the application
attributeKeystringThe attribute as category.name, unique
category"action" | "environment" | "resource" | "subject"What it is an attribute of
valueType"boolean" | "instant" | "integer" | "text" | "text_set"The type of its values
source"derived" | "directory" | "posture" | "request" | "stored"Where its values come from
resourceTypestring | nullThe kind of resource it applies to
sensitivity"confidential" | "internal" | "public" | "restricted"How sensitive its values are
freshnessSecondsnumber | nullHow old a stored value may be before it reads as unknown
definitionstringWhat the attribute means
status"active" | "retired"Whether the attribute is in use
tenantIdstring | nullThe tenant that defined it; empty for the platform's
identityAbac.AttributeDefinitionInsertinterfaceno test imports it
interface AttributeDefinitionInsert

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

MemberTypeWhat it is
attributeDefinitionIdstring
attributeKeystring
category"action" | "environment" | "resource" | "subject"
valueType"boolean" | "instant" | "integer" | "text" | "text_set"
source"derived" | "directory" | "posture" | "request" | "stored"
resourceType?string | null
sensitivity"confidential" | "internal" | "public" | "restricted"
freshnessSeconds?number | null
definitionstring
status"active" | "retired"
tenantId?string | null
identityAbac.AttributeDefinitionKeytypeno test imports it
type AttributeDefinitionKey = { readonly attributeDefinitionId: string };

The key of a row of attribute_definition.

identityAbac.attributeDefinitionconstno test imports it
const attributeDefinition: Table<AttributeDefinitionRow, AttributeDefinitionInsert, "attributeDefinition">

An attribute that decisions may use, with its type, where its values come from and how old they may be

identityAbac.AttributeDefinitionSubjectKindsRowinterfaceno test imports it
interface AttributeDefinitionSubjectKindsRow

The kinds of principal it applies to; every kind where none is said

MemberTypeWhat it is
attributeDefinitionIdstringAn attribute that decisions may use, with its type, where its values come from and how old they may be
subjectKindsstringThe kinds of principal it applies to; every kind where none is said
identityAbac.AttributeDefinitionSubjectKindsInsertinterfaceno test imports it
interface AttributeDefinitionSubjectKindsInsert

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

MemberTypeWhat it is
attributeDefinitionIdstring
subjectKindsstring
identityAbac.AttributeDefinitionSubjectKindsKeytypeno test imports it
type AttributeDefinitionSubjectKindsKey = { readonly attributeDefinitionId: string; readonly subjectKinds: string };

The key of a row of attribute_definition_subject_kinds.

identityAbac.attributeDefinitionSubjectKindsconstno test imports it
const attributeDefinitionSubjectKinds: Table<AttributeDefinitionSubjectKindsRow, AttributeDefinitionSubjectKindsInsert, "attributeDefinitionSubjectKinds">

The kinds of principal it applies to; every kind where none is said

identityAbac.PrincipalAttributeRowinterfaceno test imports it
interface PrincipalAttributeRow

A value of an attribute for a principal of any kind

MemberTypeWhat it is
principalIdstringThe principal
definitionAttributeDefinitionIdstringThe attribute
valueunknownThe value, of the type the definition says
validFromTimestampWhen the value starts to hold
validToTimestamp | nullWhen it stops, where it does
updatedAtTimestampWhen it was last asserted
assertedByPrincipalIdstring | nullWho asserted it, where a principal did
identityAbac.PrincipalAttributeInsertinterfaceno test imports it
interface PrincipalAttributeInsert

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

MemberTypeWhat it is
principalIdstring
definitionAttributeDefinitionIdstring
valueunknown
validFromTimestamp
validTo?Timestamp | null
updatedAtTimestamp
assertedByPrincipalId?string | null
identityAbac.PrincipalAttributeKeytypeno test imports it
type PrincipalAttributeKey = { readonly principalId: string; readonly definitionAttributeDefinitionId: string };

The key of a row of principal_attribute.

identityAbac.principalAttributeconstno test imports it
const principalAttribute: Table<PrincipalAttributeRow, PrincipalAttributeInsert, "principalAttribute">

A value of an attribute for a principal of any kind

identityAbac.ResourceAttributeRowinterfaceno test imports it
interface ResourceAttributeRow

A value of an attribute for a resource

MemberTypeWhat it is
resourceAttributeIdstringWhat identifies the value, made by the application
resourceTypestringThe kind of resource
resourceIdstringThe resource
valueunknownThe value, of the type the definition says
updatedAtTimestampWhen it was last asserted
valueKeystringA hash of the tenant, the resource and the attribute, unique, so that a resource has one value of an attribute
tenantIdstringThe tenant the resource is in
definitionAttributeDefinitionIdstringThe attribute
identityAbac.ResourceAttributeInsertinterfaceno test imports it
interface ResourceAttributeInsert

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

MemberTypeWhat it is
resourceAttributeIdstring
resourceTypestring
resourceIdstring
valueunknown
updatedAtTimestamp
valueKeystring
tenantIdstring
definitionAttributeDefinitionIdstring
identityAbac.ResourceAttributeKeytypeno test imports it
type ResourceAttributeKey = { readonly resourceAttributeId: string };

The key of a row of resource_attribute.

identityAbac.resourceAttributeconstno test imports it
const resourceAttribute: Table<ResourceAttributeRow, ResourceAttributeInsert, "resourceAttribute">

A value of an attribute for a resource

identityAbac.AccessPolicyRowinterfaceno test imports it
interface AccessPolicyRow

A rule of attribute-based access: a condition over attributes that allows or refuses an action; a refusal always wins

MemberTypeWhat it is
accessPolicyIdstringWhat identifies the policy, made by the application
namestringWhat the policy is called
definitionstringWhat the policy is for
effect"allow" | "deny"What it decides
appliesTo"agent" | "device" | "group" | "machine" | "user" | nullThe kind of principal it is about; every kind where it is empty
actionPatternstringThe permission it is about: exact, or a prefix ending *
resourceTypestring | nullThe kind of resource it is about
expressionstringWhen it applies, written in its language
expressionLanguageCodestringThe language of the condition
obligation"approval" | "none" | "step_up"What must happen before an allowed action is done
prioritynumberThe order policies are evaluated and explained in; a refusal wins whatever it is
status"active" | "retired"Whether it is applied
versionnumberWhich version of the policy this is
validFromTimestamp | nullWhen it starts to apply
validToTimestamp | nullWhen it stops
policyKeystringA hash of the tenant, the name and the version, unique
tenantIdstring | nullThe tenant it is for; empty for the platform's
scopePrincipalPrincipalIdstring | nullThe principal or group it is scoped to
requiresRoleAccessRoleRoleIdstring | nullA role a principal must also hold for the policy to allow
permissionIdstring | nullThe permission it is about, where it is about exactly one
identityAbac.AccessPolicyInsertinterfaceno test imports it
interface AccessPolicyInsert

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

MemberTypeWhat it is
accessPolicyIdstring
namestring
definitionstring
effect"allow" | "deny"
appliesTo?"agent" | "device" | "group" | "machine" | "user" | null
actionPatternstring
resourceType?string | null
expressionstring
expressionLanguageCodestring
obligation"approval" | "none" | "step_up"
prioritynumber
status"active" | "retired"
versionnumber
validFrom?Timestamp | null
validTo?Timestamp | null
policyKeystring
tenantId?string | null
scopePrincipalPrincipalId?string | null
requiresRoleAccessRoleRoleId?string | null
permissionId?string | null
identityAbac.AccessPolicyKeytypeno test imports it
type AccessPolicyKey = { readonly accessPolicyId: string };

The key of a row of access_policy.

identityAbac.accessPolicyconstno test imports it
const accessPolicy: Table<AccessPolicyRow, AccessPolicyInsert, "accessPolicy">

A rule of attribute-based access: a condition over attributes that allows or refuses an action; a refusal always wins

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