core

Documentation

Index

• type ActionDefinition
• type AuditEvent
• type MigrationStatus
• type Namespace
• type Policy
• type PolicyTemplate
• type ResourceAttribute
• type ResourceDefinition
• type TemplateParameter

Types

type ActionDefinition

type ActionDefinition struct {
	ID          xid.ID    `json:"id" bun:"id,pk"`
	NamespaceID xid.ID    `json:"namespaceId" bun:"namespace_id,notnull"`
	Name        string    `json:"name" bun:"name,notnull"`
	Description string    `json:"description" bun:"description"`
	CreatedAt   time.Time `json:"createdAt" bun:"created_at,notnull"`
}

ActionDefinition defines a custom action for an organization

type AuditEvent

type AuditEvent struct {
	ID                 xid.ID                 `json:"id" bun:"id,pk"`
	AppID              xid.ID                 `json:"appId" bun:"app_id,notnull"`                              // Platform app (required)
	UserOrganizationID *xid.ID                `json:"userOrganizationId,omitempty" bun:"user_organization_id"` // User-created org (optional)
	ActorID            xid.ID                 `json:"actorId" bun:"actor_id,notnull"`
	Action             string                 `json:"action" bun:"action,notnull"`
	ResourceType       string                 `json:"resourceType" bun:"resource_type"`
	ResourceID         xid.ID                 `json:"resourceId" bun:"resource_id"`
	OldValue           map[string]interface{} `json:"oldValue,omitempty" bun:"old_value,type:jsonb"`
	NewValue           map[string]interface{} `json:"newValue,omitempty" bun:"new_value,type:jsonb"`
	IPAddress          string                 `json:"ipAddress" bun:"ip_address"`
	UserAgent          string                 `json:"userAgent" bun:"user_agent"`
	Timestamp          time.Time              `json:"timestamp" bun:"timestamp,notnull"`
}

AuditEvent records a permission-related event Updated for V2 architecture: App → Environment → Organization

type MigrationStatus

type MigrationStatus struct {
	AppID              xid.ID     `json:"appId"`                        // Platform app
	UserOrganizationID *xid.ID    `json:"userOrganizationId,omitempty"` // User-created org (optional)
	StartedAt          time.Time  `json:"startedAt"`
	CompletedAt        *time.Time `json:"completedAt,omitempty"`
	Status             string     `json:"status"` // pending, in_progress, completed, failed
	TotalPolicies      int        `json:"totalPolicies"`
	MigratedCount      int        `json:"migratedCount"`
	FailedCount        int        `json:"failedCount"`
	ValidationPassed   bool       `json:"validationPassed"`
	Errors             []string   `json:"errors,omitempty"`
}

MigrationStatus tracks RBAC to Permissions migration progress Updated for V2 architecture: App → Environment → Organization

type Namespace

type Namespace struct {
	ID                 xid.ID                `json:"id" bun:"id,pk"`
	AppID              xid.ID                `json:"appId" bun:"app_id,notnull"`                              // Platform app (required)
	UserOrganizationID *xid.ID               `json:"userOrganizationId,omitempty" bun:"user_organization_id"` // User-created org (optional)
	Name               string                `json:"name" bun:"name"`
	Description        string                `json:"description" bun:"description"`
	TemplateID         *xid.ID               `json:"templateId,omitempty" bun:"template_id"`
	InheritPlatform    bool                  `json:"inheritPlatform" bun:"inherit_platform,default:false"`
	Resources          []*ResourceDefinition `json:"resources" bun:"-"`
	Actions            []*ActionDefinition   `json:"actions" bun:"-"`
	CreatedAt          time.Time             `json:"createdAt" bun:"created_at,notnull"`
	UpdatedAt          time.Time             `json:"updatedAt" bun:"updated_at,notnull"`
}

Namespace represents an organization-scoped policy namespace Updated for V2 architecture: App → Environment → Organization

type Policy

type Policy struct {
	ID                 xid.ID    `json:"id" bun:"id,pk"`
	AppID              xid.ID    `json:"appId" bun:"app_id,notnull"`                              // Platform app (required)
	UserOrganizationID *xid.ID   `json:"userOrganizationId,omitempty" bun:"user_organization_id"` // User-created org (optional)
	NamespaceID        xid.ID    `json:"namespaceId" bun:"namespace_id,notnull"`
	Name               string    `json:"name" bun:"name,notnull"`
	Description        string    `json:"description" bun:"description"`
	Expression         string    `json:"expression" bun:"expression,notnull"`
	ResourceType       string    `json:"resourceType" bun:"resource_type,notnull"`
	Actions            []string  `json:"actions" bun:"actions,array"`
	Priority           int       `json:"priority" bun:"priority,default:0"`
	Enabled            bool      `json:"enabled" bun:"enabled,default:true"`
	Version            int       `json:"version" bun:"version,default:1"`
	CreatedBy          xid.ID    `json:"createdBy" bun:"created_by"`
	CreatedAt          time.Time `json:"createdAt" bun:"created_at,notnull"`
	UpdatedAt          time.Time `json:"updatedAt" bun:"updated_at,notnull"`
}

Policy represents a permission policy Updated for V2 architecture: App → Environment → Organization

type PolicyTemplate

type PolicyTemplate struct {
	ID          string              `json:"id"`
	Name        string              `json:"name"`
	Description string              `json:"description"`
	Category    string              `json:"category"`
	Expression  string              `json:"expression"`
	Parameters  []TemplateParameter `json:"parameters"`
	Examples    []string            `json:"examples"`
}

PolicyTemplate represents a reusable policy pattern

type ResourceAttribute

type ResourceAttribute struct {
	Name        string      `json:"name"`
	Type        string      `json:"type"` // string, int, bool, array, object
	Required    bool        `json:"required"`
	Default     interface{} `json:"default,omitempty"`
	Description string      `json:"description,omitempty"`
}

ResourceAttribute defines an attribute that can be used in policy expressions

type ResourceDefinition

type ResourceDefinition struct {
	ID          xid.ID              `json:"id" bun:"id,pk"`
	NamespaceID xid.ID              `json:"namespaceId" bun:"namespace_id,notnull"`
	Type        string              `json:"type" bun:"type,notnull"`
	Description string              `json:"description" bun:"description"`
	Attributes  []ResourceAttribute `json:"attributes" bun:"attributes,type:jsonb"`
	CreatedAt   time.Time           `json:"createdAt" bun:"created_at,notnull"`
}

ResourceDefinition defines a custom resource type for an organization

type TemplateParameter

type TemplateParameter struct {
	Name         string      `json:"name"`
	Type         string      `json:"type"`
	Description  string      `json:"description"`
	Required     bool        `json:"required"`
	DefaultValue interface{} `json:"defaultValue,omitempty"`
}

TemplateParameter defines a parameter that can be substituted in a template