Files
iam/pkg/schema/organization.go

133 lines
7.5 KiB
Go

// Copyright 2026 Hanzo AI, Inc.
// SPDX-License-Identifier: MIT OR Apache-2.0
package schema
import "github.com/hanzoai/orm"
// AccountItem is one self-service profile field an organization exposes to its
// members, together with the rules that govern who may view or change it.
type AccountItem struct {
Name string `json:"name" orm:"varchar(255)"`
Visible bool `json:"visible" orm:"bool"`
ViewRule string `json:"viewRule" orm:"varchar(255)"`
ModifyRule string `json:"modifyRule" orm:"varchar(255)"`
Regex string `json:"regex" orm:"varchar(255)"`
Tab string `json:"tab" orm:"varchar(255)"`
}
// ThemeData is an organization's default UI theme, inherited by its
// applications unless they override it. It is shared with Application, which
// carries the same shape as its per-app theme override.
type ThemeData struct {
ThemeType string `json:"themeType" orm:"varchar(30)"`
ColorPrimary string `json:"colorPrimary" orm:"varchar(10)"`
BorderRadius int `json:"borderRadius" orm:"int"`
IsCompact bool `json:"isCompact" orm:"bool"`
IsEnabled bool `json:"isEnabled" orm:"bool"`
}
// Organization is a tenant boundary: the top-level owner scope every other IAM
// entity is filed under. Its natural key is the (Owner, Name) pair; orm carries
// the surrogate id, audit timestamps, and soft-delete flag on the embedded
// Model, while CreatedTime preserves the v1 display timestamp verbatim.
//
// Every field below is carried over from the v1 record so no authentication or
// tenant-policy data is lost in the migration.
type Organization struct {
orm.Model[Organization]
Owner string `json:"owner" orm:"varchar(100) notnull pk"`
Name string `json:"name" orm:"varchar(100) notnull pk"`
CreatedTime string `json:"createdTime" orm:"varchar(100)" url:"-"`
DisplayName string `json:"displayName" orm:"varchar(100)" url:"-"`
WebsiteUrl string `json:"websiteUrl" orm:"varchar(100)" url:"-"`
Logo string `json:"logo" orm:"varchar(200)" url:"-"`
LogoDark string `json:"logoDark" orm:"varchar(200)" url:"-"`
Favicon string `json:"favicon" orm:"varchar(200)" url:"-"`
// How the organization appears across Hanzo — the square mark beside its
// name — as an image or as one emoji, never both. It is the pair a person
// carries (User.Avatar) under the same names, resolved the same way, so a
// screen draws a subject without asking which kind of subject it has. Both
// halves live on the row: a mark that appears everywhere cannot be kept on
// one device. Written through schema.MarkOf; Logo and LogoDark above are a
// different thing, the wordmark a login screen draws.
Avatar string `json:"avatar" orm:"varchar(255)" url:"-"`
Emoji string `json:"emoji" orm:"varchar(64)" url:"-"`
HasPrivilegeConsent bool `json:"hasPrivilegeConsent" orm:"bool" url:"-"`
PasswordType string `json:"passwordType" orm:"varchar(100)" url:"-"`
PasswordSalt string `json:"passwordSalt" orm:"varchar(100)" url:"-"`
PasswordOptions []string `json:"passwordOptions" orm:"mediumtext"`
PasswordObfuscatorType string `json:"passwordObfuscatorType" orm:"varchar(100)" url:"-"`
PasswordObfuscatorKey string `json:"passwordObfuscatorKey" orm:"varchar(100)" url:"-"`
PasswordExpireDays int `json:"passwordExpireDays" orm:"int" url:"-"`
CountryCodes []string `json:"countryCodes" orm:"mediumtext"`
DefaultAvatar string `json:"defaultAvatar" orm:"varchar(200)" url:"-"`
UsePermanentAvatar bool `json:"usePermanentAvatar" orm:"bool" url:"-"`
DefaultApplication string `json:"defaultApplication" orm:"varchar(100)" url:"-"`
UserTypes []string `json:"userTypes" orm:"mediumtext"`
Tags []string `json:"tags" orm:"mediumtext"`
Languages []string `json:"languages" orm:"mediumtext"`
ThemeData *ThemeData `json:"themeData" orm:"json"`
MasterPassword string `json:"masterPassword" orm:"varchar(200)" url:"-"`
DefaultPassword string `json:"defaultPassword" orm:"varchar(200)" url:"-"`
MasterVerificationCode string `json:"masterVerificationCode" orm:"varchar(100)" url:"-"`
IpWhitelist string `json:"ipWhitelist" orm:"varchar(200)" url:"-"`
InitScore int `json:"initScore" orm:"int" url:"-"`
EnableSoftDeletion bool `json:"enableSoftDeletion" orm:"bool" url:"-"`
IsProfilePublic bool `json:"isProfilePublic" orm:"bool" url:"-"`
UseEmailAsUsername bool `json:"useEmailAsUsername" orm:"bool" url:"-"`
EnableTour bool `json:"enableTour" orm:"bool" url:"-"`
DisableSignin bool `json:"disableSignin" orm:"bool" url:"-"`
IpRestriction string `json:"ipRestriction" orm:"varchar(255)" url:"-"`
NavItems []string `json:"navItems" orm:"mediumtext"`
UserNavItems []string `json:"userNavItems" orm:"mediumtext"`
WidgetItems []string `json:"widgetItems" orm:"mediumtext"`
MfaItems []*MfaItem `json:"mfaItems" orm:"mediumtext"`
MfaRememberInHours int `json:"mfaRememberInHours" orm:"int" url:"-"`
AccountMenu string `json:"accountMenu" orm:"varchar(20)" url:"-"`
AccountItems []*AccountItem `json:"accountItems" orm:"mediumtext"`
// Per-organization signin throttle. Zero means "inherit the application
// default"; a non-zero value overrides it. Safe bounds are clamped by the
// resource service before persistence.
FailedSigninLimit int `json:"failedSigninLimit" orm:"int" url:"-"`
FailedSigninFrozenTime int `json:"failedSigninFrozenTime" orm:"int" url:"-"`
DcrPolicy string `json:"dcrPolicy" orm:"varchar(100)" url:"-"`
LdapAttributes []string `json:"ldapAttributes" orm:"mediumtext"`
KerberosRealm string `json:"kerberosRealm" orm:"varchar(200)" url:"-"`
KerberosKdcHost string `json:"kerberosKdcHost" orm:"varchar(200)" url:"-"`
KerberosKeytab string `json:"kerberosKeytab" orm:"mediumtext" url:"-"`
KerberosServiceName string `json:"kerberosServiceName" orm:"varchar(100)" url:"-"`
// Balance fields are read-only mirrors; authoritative balances live in
// Commerce (billing.hanzo.ai). Carried for field-complete v1 parity.
OrgBalance float64 `json:"orgBalance" orm:"double" url:"-"`
UserBalance float64 `json:"userBalance" orm:"double" url:"-"`
BalanceCredit float64 `json:"balanceCredit" orm:"double" url:"-"`
BalanceCurrency string `json:"balanceCurrency" orm:"varchar(100)" url:"-"`
IsPersonal bool `json:"isPersonal" orm:"bool" url:"-"`
// Founder is the stable storage id of the identity that provisioned this org
// (self-service onboarding). It is the resume token that makes provisioning
// converge on a backend where each write autocommits independently (no
// transaction rollback): after a partial failure that created the org but did
// not move the founder in, a retry recognises the org as the founder's own and
// completes it, instead of refusing it as "already taken". It also fences the
// org to ONE tenant — a different identity can never complete or join it.
Founder string `json:"founder,omitempty" orm:"varchar(255)" url:"-"`
// Platform marks an organization the platform itself declares (init_data.json):
// the brand orgs and the others the seed creates, never one a customer made. The
// seed stamps it on every declared organization at boot, and no request sets or
// clears it. Only a SuperAdmin may delete an organization that carries it.
Platform bool `json:"platform" url:"-"`
}