identityAccessnamespacenamespace identityAccessThe typed tables of the identityAccess model, generated by IFC Data from the model. Do not edit: change the model and run bun tools/typed.ts --write.
Role-based access for every kind of principal
identityAccessnamespacenamespace identityAccessidentityAccess.EntitlementSourceRowinterfaceno test imports itinterface EntitlementSourceRowWhere a tenant's entitlement comes from
| Member | Type | What it is |
|---|---|---|
code | string | The code other tables point to: a short word that does not change |
label | string | What a person is shown for the code |
description | string | null | What the code means, where the label is not enough |
identityAccess.EntitlementSourceInsertinterfaceno test imports itinterface EntitlementSourceInsertWhat an insert into entitlement_source takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
code | string | |
label | string | |
description? | string | null |
identityAccess.EntitlementSourceKeytypeno test imports ittype EntitlementSourceKey = { readonly code: string };The key of a row of entitlement_source.
identityAccess.entitlementSourceconstno test imports itconst entitlementSource: Table<EntitlementSourceRow, EntitlementSourceInsert, "entitlementSource">Where a tenant's entitlement comes from
identityAccess.SeparationKindRowinterfaceno test imports itinterface SeparationKindRowHow a separation of duties is held
| Member | Type | What it is |
|---|---|---|
code | string | The code other tables point to: a short word that does not change |
label | string | What a person is shown for the code |
description | string | null | What the code means, where the label is not enough |
identityAccess.SeparationKindInsertinterfaceno test imports itinterface SeparationKindInsertWhat an insert into separation_kind takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
code | string | |
label | string | |
description? | string | null |
identityAccess.SeparationKindKeytypeno test imports ittype SeparationKindKey = { readonly code: string };The key of a row of separation_kind.
identityAccess.separationKindconstno test imports itconst separationKind: Table<SeparationKindRow, SeparationKindInsert, "separationKind">How a separation of duties is held
identityAccess.PermissionRowinterfaceno test imports itinterface PermissionRowA thing that can be done, named by its resource and its action
| Member | Type | What it is |
|---|---|---|
permissionId | string | What identifies the permission, made by the application |
permissionKey | string | The permission as resource:action, unique |
definition | string | What the permission lets a principal do |
ownerModule | string | The module that registered the permission |
riskLevel | "critical" | "high" | "low" | "medium" | How much harm it can do if it is misused |
sideEffect | "external" | "irreversible" | "none" | "read" | "write" | What using it does |
featureKey | string | null | The feature a tenant must be entitled to for the permission to count |
identityAccess.PermissionInsertinterfaceno test imports itinterface PermissionInsertWhat an insert into permission takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
permissionId | string | |
permissionKey | string | |
definition | string | |
ownerModule | string | |
riskLevel | "critical" | "high" | "low" | "medium" | |
sideEffect | "external" | "irreversible" | "none" | "read" | "write" | |
featureKey? | string | null |
identityAccess.PermissionKeytypeno test imports ittype PermissionKey = { readonly permissionId: string };The key of a row of permission.
identityAccess.permissionconstno test imports itconst permission: Table<PermissionRow, PermissionInsert, "permission">A thing that can be done, named by its resource and its action
identityAccess.PermissionAppliesToRowinterfaceno test imports itinterface PermissionAppliesToRowThe kinds of principal that may hold it; every kind where none is said
| Member | Type | What it is |
|---|---|---|
permissionId | string | A thing that can be done, named by its resource and its action |
appliesTo | string | The kinds of principal that may hold it; every kind where none is said |
identityAccess.PermissionAppliesToInsertinterfaceno test imports itinterface PermissionAppliesToInsertWhat an insert into permission_applies_to takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
permissionId | string | |
appliesTo | string |
identityAccess.PermissionAppliesToKeytypeno test imports ittype PermissionAppliesToKey = { readonly permissionId: string; readonly appliesTo: string };The key of a row of permission_applies_to.
identityAccess.permissionAppliesToconstno test imports itconst permissionAppliesTo: Table<PermissionAppliesToRow, PermissionAppliesToInsert, "permissionAppliesTo">The kinds of principal that may hold it; every kind where none is said
identityAccess.AccessRoleRowinterfaceno test imports itinterface AccessRoleRowA set of permissions that is granted together, and that may inherit those of other roles
| Member | Type | What it is |
|---|---|---|
roleId | string | What identifies the role, made by the application |
roleKey | string | The role's short name, unique within its tenant |
name | string | What the role is called |
kind | "custom" | "system" | Whether the platform or a tenant made it |
definition | string | What a holder of the role does |
isPrivileged | boolean | Whether it is a role that an agent may never hold, and that needs a time-boxed grant where privileged access is composed |
status | "active" | "retired" | Whether the role is in use |
tenantId | string | null | The tenant that made the role; empty for a role of the platform, usable in every tenant |
identityAccess.AccessRoleInsertinterfaceno test imports itinterface AccessRoleInsertWhat an insert into access_role takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
roleId | string | |
roleKey | string | |
name | string | |
kind | "custom" | "system" | |
definition | string | |
isPrivileged | boolean | |
status | "active" | "retired" | |
tenantId? | string | null |
identityAccess.AccessRoleKeytypeno test imports ittype AccessRoleKey = { readonly roleId: string };The key of a row of access_role.
identityAccess.accessRoleconstno test imports itconst accessRole: Table<AccessRoleRow, AccessRoleInsert, "accessRole">A set of permissions that is granted together, and that may inherit those of other roles
identityAccess.AccessRoleAppliesToRowinterfaceno test imports itinterface AccessRoleAppliesToRowThe kinds of principal that may hold it; people, machines and groups where none is said
| Member | Type | What it is |
|---|---|---|
accessRoleRoleId | string | A set of permissions that is granted together, and that may inherit those of other roles |
appliesTo | string | The kinds of principal that may hold it; people, machines and groups where none is said |
identityAccess.AccessRoleAppliesToInsertinterfaceno test imports itinterface AccessRoleAppliesToInsertWhat an insert into access_role_applies_to takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
accessRoleRoleId | string | |
appliesTo | string |
identityAccess.AccessRoleAppliesToKeytypeno test imports ittype AccessRoleAppliesToKey = { readonly accessRoleRoleId: string; readonly appliesTo: string };The key of a row of access_role_applies_to.
identityAccess.accessRoleAppliesToconstno test imports itconst accessRoleAppliesTo: Table<AccessRoleAppliesToRow, AccessRoleAppliesToInsert, "accessRoleAppliesTo">The kinds of principal that may hold it; people, machines and groups where none is said
identityAccess.RoleInheritanceRowinterfaceno test imports itinterface RoleInheritanceRowA role that inherits another: whoever holds the senior role holds what the junior role holds
| Member | Type | What it is |
|---|---|---|
seniorAccessRoleRoleId | string | The role that inherits |
juniorAccessRoleRoleId | string | The role that is inherited |
identityAccess.RoleInheritanceInsertinterfaceno test imports itinterface RoleInheritanceInsertWhat an insert into role_inheritance takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
seniorAccessRoleRoleId | string | |
juniorAccessRoleRoleId | string |
identityAccess.RoleInheritanceKeytypeno test imports ittype RoleInheritanceKey = { readonly seniorAccessRoleRoleId: string; readonly juniorAccessRoleRoleId: string };The key of a row of role_inheritance.
identityAccess.roleInheritanceconstno test imports itconst roleInheritance: Table<RoleInheritanceRow, RoleInheritanceInsert, "roleInheritance">A role that inherits another: whoever holds the senior role holds what the junior role holds
identityAccess.RolePermissionRowinterfaceno test imports itinterface RolePermissionRowA permission that a role holds
| Member | Type | What it is |
|---|---|---|
roleAccessRoleRoleId | string | The role |
permissionId | string | The permission |
identityAccess.RolePermissionInsertinterfaceno test imports itinterface RolePermissionInsertWhat an insert into role_permission takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
roleAccessRoleRoleId | string | |
permissionId | string |
identityAccess.RolePermissionKeytypeno test imports ittype RolePermissionKey = { readonly roleAccessRoleRoleId: string; readonly permissionId: string };The key of a row of role_permission.
identityAccess.rolePermissionconstno test imports itconst rolePermission: Table<RolePermissionRow, RolePermissionInsert, "rolePermission">A permission that a role holds
identityAccess.SeparationRuleRowinterfaceno test imports itinterface SeparationRuleRowA rule that no principal may hold too many of a set of roles together
| Member | Type | What it is |
|---|---|---|
separationRuleId | string | What identifies the rule, made by the application |
name | string | What the rule is called |
separationKindCode | string | How the separation is held |
limitCount | number | How many of the roles together are too many: two for the classic pair |
status | "active" | "retired" | Whether the rule is applied |
tenantId | string | null | The tenant the rule is for; empty for the platform's |
identityAccess.SeparationRuleInsertinterfaceno test imports itinterface SeparationRuleInsertWhat an insert into separation_rule takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
separationRuleId | string | |
name | string | |
separationKindCode | string | |
limitCount | number | |
status | "active" | "retired" | |
tenantId? | string | null |
identityAccess.SeparationRuleKeytypeno test imports ittype SeparationRuleKey = { readonly separationRuleId: string };The key of a row of separation_rule.
identityAccess.separationRuleconstno test imports itconst separationRule: Table<SeparationRuleRow, SeparationRuleInsert, "separationRule">A rule that no principal may hold too many of a set of roles together
identityAccess.SeparationRuleRoleRowinterfaceno test imports itinterface SeparationRuleRoleRowA role that a separation rule is about
| Member | Type | What it is |
|---|---|---|
ruleSeparationRuleId | string | The rule |
roleAccessRoleRoleId | string | The role |
identityAccess.SeparationRuleRoleInsertinterfaceno test imports itinterface SeparationRuleRoleInsertWhat an insert into separation_rule_role takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
ruleSeparationRuleId | string | |
roleAccessRoleRoleId | string |
identityAccess.SeparationRuleRoleKeytypeno test imports ittype SeparationRuleRoleKey = { readonly ruleSeparationRuleId: string; readonly roleAccessRoleRoleId: string };The key of a row of separation_rule_role.
identityAccess.separationRuleRoleconstno test imports itconst separationRuleRole: Table<SeparationRuleRoleRow, SeparationRuleRoleInsert, "separationRuleRole">A role that a separation rule is about
identityAccess.RoleAssignmentRowinterfaceno test imports itinterface RoleAssignmentRowA role granted to a principal of any kind, in a tenant, perhaps for one resource and for a time
| Member | Type | What it is |
|---|---|---|
roleAssignmentId | string | What identifies the grant, made by the application |
resourceType | string | null | The kind of the one resource the grant is limited to, where it is |
resourceId | string | null | The one resource the grant is limited to, where it is |
validFrom | Timestamp | When the grant starts |
validTo | Timestamp | null | When the grant ends, where it does |
reason | string | null | Why it was granted |
status | "active" | "expired" | "revoked" | Where the grant is |
revokedAt | Timestamp | null | When it was ended early |
via | "direct" | "directory" | "invitation" | "privileged_grant" | How it came to be |
assignmentKey | string | A hash of the principal, the role, the tenant and the resource, unique, so that a grant is not made twice where the resource is empty |
principalId | string | Who holds the role |
roleAccessRoleRoleId | string | The role |
tenantId | string | The tenant the grant is in |
grantedByPrincipalId | string | Who granted it |
identityAccess.RoleAssignmentInsertinterfaceno test imports itinterface RoleAssignmentInsertWhat an insert into role_assignment takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
roleAssignmentId | string | |
resourceType? | string | null | |
resourceId? | string | null | |
validFrom | Timestamp | |
validTo? | Timestamp | null | |
reason? | string | null | |
status | "active" | "expired" | "revoked" | |
revokedAt? | Timestamp | null | |
via | "direct" | "directory" | "invitation" | "privileged_grant" | |
assignmentKey | string | |
principalId | string | |
roleAccessRoleRoleId | string | |
tenantId | string | |
grantedByPrincipalId | string |
identityAccess.RoleAssignmentKeytypeno test imports ittype RoleAssignmentKey = { readonly roleAssignmentId: string };The key of a row of role_assignment.
identityAccess.roleAssignmentconstno test imports itconst roleAssignment: Table<RoleAssignmentRow, RoleAssignmentInsert, "roleAssignment">A role granted to a principal of any kind, in a tenant, perhaps for one resource and for a time
identityAccess.EntitlementRowinterfaceno test imports itinterface EntitlementRowWhat a tenant may use, as distinct from what a principal may do
| Member | Type | What it is |
|---|---|---|
entitlementId | string | What identifies the entitlement, made by the application |
featureKey | string | The feature the tenant may use |
limitValue | number | null | How much of it, where it is limited |
validFrom | Timestamp | When it starts |
validTo | Timestamp | null | When it ends, where it does |
entitlementSourceCode | string | Where it comes from |
tenantId | string | The tenant |
identityAccess.EntitlementInsertinterfaceno test imports itinterface EntitlementInsertWhat an insert into entitlement takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
entitlementId | string | |
featureKey | string | |
limitValue? | number | null | |
validFrom | Timestamp | |
validTo? | Timestamp | null | |
entitlementSourceCode | string | |
tenantId | string |
identityAccess.EntitlementKeytypeno test imports ittype EntitlementKey = { readonly entitlementId: string };The key of a row of entitlement.
identityAccess.entitlementconstno test imports itconst entitlement: Table<EntitlementRow, EntitlementInsert, "entitlement">What a tenant may use, as distinct from what a principal may do
identityAccess.InvitationRoleRowinterfaceno test imports itinterface InvitationRoleRowA role that an invitation grants when it is accepted
| Member | Type | What it is |
|---|---|---|
invitationId | string | The invitation |
roleAccessRoleRoleId | string | The role |
identityAccess.InvitationRoleInsertinterfaceno test imports itinterface InvitationRoleInsertWhat an insert into invitation_role takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
invitationId | string | |
roleAccessRoleRoleId | string |
identityAccess.InvitationRoleKeytypeno test imports ittype InvitationRoleKey = { readonly invitationId: string; readonly roleAccessRoleRoleId: string };The key of a row of invitation_role.
identityAccess.invitationRoleconstno test imports itconst invitationRole: Table<InvitationRoleRow, InvitationRoleInsert, "invitationRole">A role that an invitation grants when it is accepted