identityMachinenamespacenamespace identityMachineThe 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
identityMachinenamespacenamespace identityMachineidentityMachine.EnvironmentRowinterfaceno test imports itinterface EnvironmentRowWhere a machine runs
| 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 |
identityMachine.EnvironmentInsertinterfaceno test imports itinterface EnvironmentInsertWhat an insert into environment takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
code | string | |
label | string | |
description? | string | null |
identityMachine.EnvironmentKeytypeno test imports ittype EnvironmentKey = { readonly code: string };The key of a row of environment.
identityMachine.environmentconstno test imports itconst environment: Table<EnvironmentRow, EnvironmentInsert, "environment">Where a machine runs
identityMachine.MachineRowinterfaceno test imports itinterface MachineRowA program that acts for itself, with a person or a group accountable for it
| Member | Type | What it is |
|---|---|---|
principalId | string | The principal the machine is |
machineKind | "bot" | "integration" | "pipeline" | "service" | "workload" | What kind of program it is |
purpose | string | What it is for |
environmentCode | string | null | Where it runs |
isBreakGlass | boolean | Whether it is an account kept for emergencies, whose every use is reviewed |
maxCredentialDays | number | null | The longest a credential of the machine may live |
reviewBy | Timestamp | null | When the machine must next be reviewed by its owner |
identityMachine.MachineInsertinterfaceno test imports itinterface MachineInsertWhat an insert into machine takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
principalId | string | |
machineKind | "bot" | "integration" | "pipeline" | "service" | "workload" | |
purpose | string | |
environmentCode? | string | null | |
isBreakGlass | boolean | |
maxCredentialDays? | number | null | |
reviewBy? | Timestamp | null |
identityMachine.MachineKeytypeno test imports ittype MachineKey = { readonly principalId: string };The key of a row of machine.
identityMachine.machineconstno test imports itconst machine: Table<MachineRow, MachineInsert, "machine">A program that acts for itself, with a person or a group accountable for it
identityMachine.WorkloadIdentityRowinterfaceno test imports itinterface WorkloadIdentityRowWhat a platform vouches for about a workload, so that a machine proves itself by it instead of by a secret
| Member | Type | What it is |
|---|---|---|
workloadIdentityId | string | What identifies the binding, made by the application |
issuerKind | "cloud" | "kubernetes" | "mtls" | "oidc" | "spiffe" | What vouches for it |
issuer | string | The issuer |
subject | string | The workload's name for the issuer: a SPIFFE ID, a service account, a subject, a thumbprint |
trustDomain | string | null | The trust domain |
audience | string | null | The audience the proof must be for |
status | "active" | "retired" | Whether the binding is applied |
bindingKey | string | A hash of the issuer and the subject, unique |
machinePrincipalId | string | The machine the workload is |
identityMachine.WorkloadIdentityInsertinterfaceno test imports itinterface WorkloadIdentityInsertWhat an insert into workload_identity takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
workloadIdentityId | string | |
issuerKind | "cloud" | "kubernetes" | "mtls" | "oidc" | "spiffe" | |
issuer | string | |
subject | string | |
trustDomain? | string | null | |
audience? | string | null | |
status | "active" | "retired" | |
bindingKey | string | |
machinePrincipalId | string |
identityMachine.WorkloadIdentityKeytypeno test imports ittype WorkloadIdentityKey = { readonly workloadIdentityId: string };The key of a row of workload_identity.
identityMachine.workloadIdentityconstno test imports itconst 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 itinterface WorkloadIdentitySelectorsRowWhat must all match, as SPIRE's selectors do
| Member | Type | What it is |
|---|---|---|
workloadIdentityId | string | What a platform vouches for about a workload, so that a machine proves itself by it instead of by a secret |
selectors | string | What must all match, as SPIRE's selectors do |
identityMachine.WorkloadIdentitySelectorsInsertinterfaceno test imports itinterface WorkloadIdentitySelectorsInsertWhat an insert into workload_identity_selectors takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
workloadIdentityId | string | |
selectors | string |
identityMachine.WorkloadIdentitySelectorsKeytypeno test imports ittype WorkloadIdentitySelectorsKey = { readonly workloadIdentityId: string; readonly selectors: string };The key of a row of workload_identity_selectors.
identityMachine.workloadIdentitySelectorsconstno test imports itconst workloadIdentitySelectors: Table<WorkloadIdentitySelectorsRow, WorkloadIdentitySelectorsInsert, "workloadIdentitySelectors">What must all match, as SPIRE's selectors do
identityMachine.ApiKeyRowinterfaceno test imports itinterface ApiKeyRowA random secret that a program presents, kept as a keyed hash and shown once, never wider in authority than its owner
| Member | Type | What it is |
|---|---|---|
credentialId | string | The credential it is |
prefix | string | The part that is not secret, by which the key is found, unique |
secretHash | string | The keyed hash of the secret |
lastUsedAt | Timestamp | null | When it was last used |
rotatedFromApiKeyCredentialId | string | null | The key it replaced |
identityMachine.ApiKeyInsertinterfaceno test imports itinterface ApiKeyInsertWhat an insert into api_key takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
credentialId | string | |
prefix | string | |
secretHash | string | |
lastUsedAt? | Timestamp | null | |
rotatedFromApiKeyCredentialId? | string | null |
identityMachine.ApiKeyKeytypeno test imports ittype ApiKeyKey = { readonly credentialId: string };The key of a row of api_key.
identityMachine.apiKeyconstno test imports itconst 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 itinterface ApiKeyScopesRowThe permissions the key may use: the owner's, narrowed to these
| Member | Type | What it is |
|---|---|---|
apiKeyCredentialId | string | A random secret that a program presents, kept as a keyed hash and shown once, never wider in authority than its owner |
scopes | string | The permissions the key may use: the owner's, narrowed to these |
identityMachine.ApiKeyScopesInsertinterfaceno test imports itinterface ApiKeyScopesInsertWhat an insert into api_key_scopes takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
apiKeyCredentialId | string | |
scopes | string |
identityMachine.ApiKeyScopesKeytypeno test imports ittype ApiKeyScopesKey = { readonly apiKeyCredentialId: string; readonly scopes: string };The key of a row of api_key_scopes.
identityMachine.apiKeyScopesconstno test imports itconst apiKeyScopes: Table<ApiKeyScopesRow, ApiKeyScopesInsert, "apiKeyScopes">The permissions the key may use: the owner's, narrowed to these
identityMachine.ApiKeyAllowedCidrsRowinterfaceno test imports itinterface ApiKeyAllowedCidrsRowThe networks it may be used from
| Member | Type | What it is |
|---|---|---|
apiKeyCredentialId | string | A random secret that a program presents, kept as a keyed hash and shown once, never wider in authority than its owner |
allowedCidrs | string | The networks it may be used from |
identityMachine.ApiKeyAllowedCidrsInsertinterfaceno test imports itinterface ApiKeyAllowedCidrsInsertWhat an insert into api_key_allowed_cidrs takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
apiKeyCredentialId | string | |
allowedCidrs | string |
identityMachine.ApiKeyAllowedCidrsKeytypeno test imports ittype ApiKeyAllowedCidrsKey = { readonly apiKeyCredentialId: string; readonly allowedCidrs: string };The key of a row of api_key_allowed_cidrs.
identityMachine.apiKeyAllowedCidrsconstno test imports itconst apiKeyAllowedCidrs: Table<ApiKeyAllowedCidrsRow, ApiKeyAllowedCidrsInsert, "apiKeyAllowedCidrs">The networks it may be used from
identityMachine.KeyCredentialRowinterfaceno test imports itinterface KeyCredentialRowA public key that a principal proves itself with by signing; the private half is never kept
| Member | Type | What it is |
|---|---|---|
credentialId | string | The credential it is |
publicJwk | unknown | The public key as a JSON Web Key |
thumbprint | string | The RFC 7638 thumbprint of the key, unique; it is also what a proof of possession binds a token to |
algorithm | string | The signing algorithm |
identityMachine.KeyCredentialInsertinterfaceno test imports itinterface KeyCredentialInsertWhat an insert into key_credential takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
credentialId | string | |
publicJwk | unknown | |
thumbprint | string | |
algorithm | string |
identityMachine.KeyCredentialKeytypeno test imports ittype KeyCredentialKey = { readonly credentialId: string };The key of a row of key_credential.
identityMachine.keyCredentialconstno test imports itconst keyCredential: Table<KeyCredentialRow, KeyCredentialInsert, "keyCredential">A public key that a principal proves itself with by signing; the private half is never kept