Catalyst / admin/Synapse-Cortex 14.8 GB / 57.8 GB 40.0 GB free
Help Sign in

admin / Synapse-Cortex

public

Self Hosted ITSM Tool with RBAC/Tenanting and MFA

Code Issues Pull requests Pipelines Packages Security Insights Wiki Settings
Synapse-Cortex / synapse-cortex / app / schemas.py 6790 B · main
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
import uuid
from datetime import datetime
from typing import List, Optional

from pydantic import BaseModel, EmailStr, Field, field_validator

from .models import (
    AssetSource,
    AssetStatus,
    TicketPriority,
    TicketSource,
    TicketStatus,
    TicketType,
    UserRole,
)
from .utils import is_valid_mac, normalize_mac


class LoginRequest(BaseModel):
    email: EmailStr
    password: str


class SLAPolicyOut(BaseModel):
    id: uuid.UUID
    tenant_id: uuid.UUID
    priority: TicketPriority
    response_time_minutes: int
    resolution_time_minutes: int

    class Config:
        from_attributes = True


class SLAPolicyUpdate(BaseModel):
    response_time_minutes: int = Field(..., gt=0)
    resolution_time_minutes: int = Field(..., gt=0)


class SoftwareItem(BaseModel):
    name: str
    version: Optional[str] = None


class AssetTypeOptionOut(BaseModel):
    id: uuid.UUID
    tenant_id: uuid.UUID
    name: str
    created_at: datetime

    class Config:
        from_attributes = True


class AssetTypeOptionCreate(BaseModel):
    name: str = Field(..., min_length=1, max_length=80)


class AssetTypeOptionUpdate(BaseModel):
    name: str = Field(..., min_length=1, max_length=80)


class AssetCreate(BaseModel):
    name: str = Field(..., min_length=2, max_length=120)
    asset_type_id: uuid.UUID
    mac_address: str
    ip_address: Optional[str] = None
    location: Optional[str] = None
    status: AssetStatus = AssetStatus.IN_STOCK
    assigned_to_id: Optional[uuid.UUID] = None

    @field_validator("mac_address")
    @classmethod
    def validate_mac(cls, value: str) -> str:
        if not is_valid_mac(value):
            raise ValueError("mac_address must be a valid MAC address (e.g. 00:1A:2B:3C:4D:5E)")
        return normalize_mac(value)


class AssetUpdate(BaseModel):
    """Partial update for the asset detail view's independently-editable sections."""

    name: Optional[str] = Field(None, min_length=2, max_length=120)
    asset_type_id: Optional[uuid.UUID] = None
    status: Optional[AssetStatus] = None
    location: Optional[str] = None
    assigned_to_id: Optional[uuid.UUID] = None
    mac_address: Optional[str] = None
    ip_address: Optional[str] = None
    os: Optional[str] = None
    software: Optional[List[SoftwareItem]] = None

    @field_validator("mac_address")
    @classmethod
    def validate_mac(cls, value: Optional[str]) -> Optional[str]:
        if value is None or value == "":
            return None
        if not is_valid_mac(value):
            raise ValueError("mac_address must be a valid MAC address (e.g. 00:1A:2B:3C:4D:5E)")
        return normalize_mac(value)


class AssetOut(BaseModel):
    id: uuid.UUID
    tenant_id: uuid.UUID
    asset_id: str
    name: str
    asset_type_id: uuid.UUID
    asset_type_name: Optional[str] = None
    mac_address: Optional[str]
    ip_address: Optional[str]
    status: AssetStatus
    location: Optional[str]
    source: AssetSource
    os: Optional[str]
    software: Optional[List[SoftwareItem]]
    netscanxi_device_type: Optional[str]
    assigned_to_id: Optional[uuid.UUID]
    created_at: datetime

    class Config:
        from_attributes = True


class TicketCreate(BaseModel):
    title: str = Field(..., min_length=3, max_length=200)
    description: Optional[str] = None
    ticket_type: TicketType = TicketType.INCIDENT
    priority: TicketPriority = TicketPriority.MEDIUM
    asset_id: Optional[uuid.UUID] = None
    assigned_to_id: Optional[uuid.UUID] = None


class TicketUpdate(BaseModel):
    title: Optional[str] = Field(None, min_length=3, max_length=200)
    description: Optional[str] = None
    status: Optional[TicketStatus] = None
    assigned_to_id: Optional[uuid.UUID] = None
    priority: Optional[TicketPriority] = None


class TicketBulkDeleteRequest(BaseModel):
    ticket_ids: List[uuid.UUID] = Field(..., min_length=1)


class TicketOut(BaseModel):
    id: uuid.UUID
    tenant_id: uuid.UUID
    ticket_number: str
    title: str
    description: Optional[str]
    ticket_type: TicketType
    priority: TicketPriority
    status: TicketStatus
    requester_id: Optional[uuid.UUID]
    assigned_to_id: Optional[uuid.UUID]
    asset_id: Optional[uuid.UUID]
    response_due_at: Optional[datetime]
    resolution_due_at: Optional[datetime]
    resolved_at: Optional[datetime]
    source: TicketSource
    external_ref: Optional[str]
    created_at: datetime

    class Config:
        from_attributes = True


class TicketActionCreate(BaseModel):
    body: str = Field(..., min_length=1, max_length=4000)


class TicketActionOut(BaseModel):
    id: uuid.UUID
    tenant_id: uuid.UUID
    ticket_id: uuid.UUID
    user_id: Optional[uuid.UUID]
    user_name: Optional[str] = None
    body: str
    created_at: datetime

    class Config:
        from_attributes = True


class UserCreate(BaseModel):
    full_name: str = Field(..., min_length=2, max_length=120)
    email: EmailStr
    password: str = Field(..., min_length=8)
    role: UserRole = UserRole.REQUESTER


class UserUpdate(BaseModel):
    full_name: Optional[str] = Field(None, min_length=2, max_length=120)
    role: Optional[UserRole] = None
    is_active: Optional[bool] = None
    mfa_required: Optional[bool] = None


class UserOut(BaseModel):
    id: uuid.UUID
    tenant_id: uuid.UUID
    email: str
    full_name: str
    role: UserRole
    is_active: bool
    mfa_enabled: bool
    mfa_required: bool
    created_at: datetime

    class Config:
        from_attributes = True


class AuditLogOut(BaseModel):
    id: uuid.UUID
    tenant_id: uuid.UUID
    user_id: Optional[uuid.UUID]
    action: str
    detail: Optional[dict]
    ip_address: Optional[str]
    created_at: datetime

    class Config:
        from_attributes = True


class IngestAssetItem(BaseModel):
    """One device as reported by NetscanXi's scan/host dict."""

    asset_id: str
    mac: Optional[str] = None
    ip: Optional[str] = None
    hostname: Optional[str] = None
    device_type: Optional[str] = None
    os: Optional[str] = None
    software: Optional[List[SoftwareItem]] = None


class IngestRequest(BaseModel):
    assets: List[IngestAssetItem] = Field(default_factory=list)


class IngestTicketItem(BaseModel):
    """One remediation item as tracked by NetscanXi (its Remediation Tracking
    module), to be created as a Cortex ticket."""

    external_ref: str = Field(..., min_length=1)
    title: str = Field(..., min_length=1, max_length=200)
    description: Optional[str] = None
    priority: TicketPriority = TicketPriority.MEDIUM
    status: TicketStatus = TicketStatus.NEW
    asset_id: Optional[str] = None  # NetscanXi's asset_id string, resolved server-side


class IngestTicketsRequest(BaseModel):
    tickets: List[IngestTicketItem] = Field(default_factory=list)