IF Commons GitHub

sql/typed/models/identity-machine.auto

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

Machine identities: services, workloads, pipelines and integrations

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

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

identityMachinenamespace
namespace identityMachine
identityMachine.EnvironmentRowinterfaceno test imports it
interface EnvironmentRow

Where a machine runs

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
identityMachine.EnvironmentInsertinterfaceno test imports it
interface EnvironmentInsert

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

MemberTypeWhat it is
codestring
labelstring
description?string | null
identityMachine.EnvironmentKeytypeno test imports it
type EnvironmentKey = { readonly code: string };

The key of a row of environment.

identityMachine.environmentconstno test imports it
const environment: Table<EnvironmentRow, EnvironmentInsert, "environment">

Where a machine runs

identityMachine.MachineRowinterfaceno test imports it
interface MachineRow

A program that acts for itself, with a person or a group accountable for it

MemberTypeWhat it is
principalIdstringThe principal the machine is
machineKind"bot" | "integration" | "pipeline" | "service" | "workload"What kind of program it is
purposestringWhat it is for
environmentCodestring | nullWhere it runs
isBreakGlassbooleanWhether it is an account kept for emergencies, whose every use is reviewed
maxCredentialDaysnumber | nullThe longest a credential of the machine may live
reviewByTimestamp | nullWhen the machine must next be reviewed by its owner
identityMachine.MachineInsertinterfaceno test imports it
interface MachineInsert

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

MemberTypeWhat it is
principalIdstring
machineKind"bot" | "integration" | "pipeline" | "service" | "workload"
purposestring
environmentCode?string | null
isBreakGlassboolean
maxCredentialDays?number | null
reviewBy?Timestamp | null
identityMachine.MachineKeytypeno test imports it
type MachineKey = { readonly principalId: string };

The key of a row of machine.

identityMachine.machineconstno test imports it
const machine: Table<MachineRow, MachineInsert, "machine">

A program that acts for itself, with a person or a group accountable for it

identityMachine.WorkloadIdentityRowinterfaceno test imports it
interface WorkloadIdentityRow

What a platform vouches for about a workload, so that a machine proves itself by it instead of by a secret

MemberTypeWhat it is
workloadIdentityIdstringWhat identifies the binding, made by the application
issuerKind"cloud" | "kubernetes" | "mtls" | "oidc" | "spiffe"What vouches for it
issuerstringThe issuer
subjectstringThe workload's name for the issuer: a SPIFFE ID, a service account, a subject, a thumbprint
trustDomainstring | nullThe trust domain
audiencestring | nullThe audience the proof must be for
status"active" | "retired"Whether the binding is applied
bindingKeystringA hash of the issuer and the subject, unique
machinePrincipalIdstringThe machine the workload is
identityMachine.WorkloadIdentityInsertinterfaceno test imports it
interface WorkloadIdentityInsert

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

MemberTypeWhat it is
workloadIdentityIdstring
issuerKind"cloud" | "kubernetes" | "mtls" | "oidc" | "spiffe"
issuerstring
subjectstring
trustDomain?string | null
audience?string | null
status"active" | "retired"
bindingKeystring
machinePrincipalIdstring
identityMachine.WorkloadIdentityKeytypeno test imports it
type WorkloadIdentityKey = { readonly workloadIdentityId: string };

The key of a row of workload_identity.

identityMachine.workloadIdentityconstno test imports it
const workloadIdentity: Table<WorkloadIdentityRow, WorkloadIdentityInsert, "workloadIdentity">

What a platform vouches for about a workload, so that a machine proves itself by it instead of by a secret

identityMachine.WorkloadIdentitySelectorsRowinterfaceno test imports it
interface WorkloadIdentitySelectorsRow

What must all match, as SPIRE's selectors do

MemberTypeWhat it is
workloadIdentityIdstringWhat a platform vouches for about a workload, so that a machine proves itself by it instead of by a secret
selectorsstringWhat must all match, as SPIRE's selectors do
identityMachine.WorkloadIdentitySelectorsInsertinterfaceno test imports it
interface WorkloadIdentitySelectorsInsert

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

MemberTypeWhat it is
workloadIdentityIdstring
selectorsstring
identityMachine.WorkloadIdentitySelectorsKeytypeno test imports it
type WorkloadIdentitySelectorsKey = { readonly workloadIdentityId: string; readonly selectors: string };

The key of a row of workload_identity_selectors.

identityMachine.workloadIdentitySelectorsconstno test imports it
const workloadIdentitySelectors: Table<WorkloadIdentitySelectorsRow, WorkloadIdentitySelectorsInsert, "workloadIdentitySelectors">

What must all match, as SPIRE's selectors do

identityMachine.ApiKeyRowinterfaceno test imports it
interface ApiKeyRow

A random secret that a program presents, kept as a keyed hash and shown once, never wider in authority than its owner

MemberTypeWhat it is
credentialIdstringThe credential it is
prefixstringThe part that is not secret, by which the key is found, unique
secretHashstringThe keyed hash of the secret
lastUsedAtTimestamp | nullWhen it was last used
rotatedFromApiKeyCredentialIdstring | nullThe key it replaced
identityMachine.ApiKeyInsertinterfaceno test imports it
interface ApiKeyInsert

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

MemberTypeWhat it is
credentialIdstring
prefixstring
secretHashstring
lastUsedAt?Timestamp | null
rotatedFromApiKeyCredentialId?string | null
identityMachine.ApiKeyKeytypeno test imports it
type ApiKeyKey = { readonly credentialId: string };

The key of a row of api_key.

identityMachine.apiKeyconstno test imports it
const apiKey: Table<ApiKeyRow, ApiKeyInsert, "apiKey">

A random secret that a program presents, kept as a keyed hash and shown once, never wider in authority than its owner

identityMachine.ApiKeyScopesRowinterfaceno test imports it
interface ApiKeyScopesRow

The permissions the key may use: the owner's, narrowed to these

MemberTypeWhat it is
apiKeyCredentialIdstringA random secret that a program presents, kept as a keyed hash and shown once, never wider in authority than its owner
scopesstringThe permissions the key may use: the owner's, narrowed to these
identityMachine.ApiKeyScopesInsertinterfaceno test imports it
interface ApiKeyScopesInsert

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

MemberTypeWhat it is
apiKeyCredentialIdstring
scopesstring
identityMachine.ApiKeyScopesKeytypeno test imports it
type ApiKeyScopesKey = { readonly apiKeyCredentialId: string; readonly scopes: string };

The key of a row of api_key_scopes.

identityMachine.apiKeyScopesconstno test imports it
const apiKeyScopes: Table<ApiKeyScopesRow, ApiKeyScopesInsert, "apiKeyScopes">

The permissions the key may use: the owner's, narrowed to these

identityMachine.ApiKeyAllowedCidrsRowinterfaceno test imports it
interface ApiKeyAllowedCidrsRow

The networks it may be used from

MemberTypeWhat it is
apiKeyCredentialIdstringA random secret that a program presents, kept as a keyed hash and shown once, never wider in authority than its owner
allowedCidrsstringThe networks it may be used from
identityMachine.ApiKeyAllowedCidrsInsertinterfaceno test imports it
interface ApiKeyAllowedCidrsInsert

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

MemberTypeWhat it is
apiKeyCredentialIdstring
allowedCidrsstring
identityMachine.ApiKeyAllowedCidrsKeytypeno test imports it
type ApiKeyAllowedCidrsKey = { readonly apiKeyCredentialId: string; readonly allowedCidrs: string };

The key of a row of api_key_allowed_cidrs.

identityMachine.apiKeyAllowedCidrsconstno test imports it
const apiKeyAllowedCidrs: Table<ApiKeyAllowedCidrsRow, ApiKeyAllowedCidrsInsert, "apiKeyAllowedCidrs">

The networks it may be used from

identityMachine.KeyCredentialRowinterfaceno test imports it
interface KeyCredentialRow

A public key that a principal proves itself with by signing; the private half is never kept

MemberTypeWhat it is
credentialIdstringThe credential it is
publicJwkunknownThe public key as a JSON Web Key
thumbprintstringThe RFC 7638 thumbprint of the key, unique; it is also what a proof of possession binds a token to
algorithmstringThe signing algorithm
identityMachine.KeyCredentialInsertinterfaceno test imports it
interface KeyCredentialInsert

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

MemberTypeWhat it is
credentialIdstring
publicJwkunknown
thumbprintstring
algorithmstring
identityMachine.KeyCredentialKeytypeno test imports it
type KeyCredentialKey = { readonly credentialId: string };

The key of a row of key_credential.

identityMachine.keyCredentialconstno test imports it
const keyCredential: Table<KeyCredentialRow, KeyCredentialInsert, "keyCredential">

A public key that a principal proves itself with by signing; the private half is never kept

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