Skip to content

schemas

UserCreate

Bases: BaseUserCreate

Schema for User creation.

Attributes:

Name Type Description
username NonEmptyStr
Source code in fractal_server/app/schemas/user.py 
74
75
76
77
78
79
80
81
82
class UserCreate(schemas.BaseUserCreate):
    """
    Schema for `User` creation.

    Attributes:
        username:
    """

    username: NonEmptyStr = None

UserGroupCreate

Bases: BaseModel

Schema for UserGroup creation

Attributes:

Name Type Description
name str

Group name
Source code in fractal_server/app/schemas/user_group.py 
43
44
45
46
47
48
49
50
51
52
53
54
class UserGroupCreate(BaseModel):
    """
    Schema for `UserGroup` creation

    Attributes:
        name: Group name
    """

    model_config = ConfigDict(extra="forbid")

    name: str
    viewer_paths: ListUniqueAbsolutePathStr = Field(default_factory=list)

UserGroupRead

Bases: BaseModel

Schema for UserGroup read

NOTE: user_ids does not correspond to a column of the UserGroup table, but it is rather computed dynamically in relevant endpoints.

Attributes:

Name Type Description
id int

Group ID
name str

Group name
timestamp_created AwareDatetime

Creation timestamp
user_ids list[int] | None

IDs of users of this group
Source code in fractal_server/app/schemas/user_group.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class UserGroupRead(BaseModel):
    """
    Schema for `UserGroup` read

    NOTE: `user_ids` does not correspond to a column of the `UserGroup` table,
    but it is rather computed dynamically in relevant endpoints.

    Attributes:
        id: Group ID
        name: Group name
        timestamp_created: Creation timestamp
        user_ids: IDs of users of this group
    """

    id: int
    name: str
    timestamp_created: AwareDatetime
    user_ids: list[int] | None = None
    viewer_paths: list[str]

    @field_serializer("timestamp_created")
    def serialize_datetime(v: datetime) -> str:
        return v.isoformat()

UserGroupUpdate

Bases: BaseModel

Schema for UserGroup update

Source code in fractal_server/app/schemas/user_group.py 
57
58
59
60
61
62
63
64
class UserGroupUpdate(BaseModel):
    """
    Schema for `UserGroup` update
    """

    model_config = ConfigDict(extra="forbid")

    viewer_paths: ListUniqueAbsolutePathStr = None

UserRead

Bases: BaseUser[int]

Schema for User read from database.

Attributes:

Name Type Description
username str | None
Source code in fractal_server/app/schemas/user.py 
34
35
36
37
38
39
40
41
42
43
44
class UserRead(schemas.BaseUser[int]):
    """
    Schema for `User` read from database.

    Attributes:
        username:
    """

    username: str | None = None
    group_ids_names: list[tuple[int, str]] | None = None
    oauth_accounts: list[OAuthAccountRead]

UserSettingsRead

Bases: BaseModel

Schema reserved for superusers

Source code in fractal_server/app/schemas/user_settings.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class UserSettingsRead(BaseModel):
    """
    Schema reserved for superusers
    """

    id: int
    ssh_host: str | None = None
    ssh_username: str | None = None
    ssh_private_key_path: str | None = None
    ssh_tasks_dir: str | None = None
    ssh_jobs_dir: str | None = None
    slurm_user: str | None = None
    slurm_accounts: list[str]
    project_dir: str | None = None

UserSettingsUpdate

Bases: BaseModel

Schema reserved for superusers

Source code in fractal_server/app/schemas/user_settings.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
class UserSettingsUpdate(BaseModel):
    """
    Schema reserved for superusers
    """

    model_config = ConfigDict(extra="forbid")

    ssh_host: NonEmptyStr | None = None
    ssh_username: NonEmptyStr | None = None
    ssh_private_key_path: AbsolutePathStr | None = None
    ssh_tasks_dir: AbsolutePathStr | None = None
    ssh_jobs_dir: AbsolutePathStr | None = None
    slurm_user: NonEmptyStr | None = None
    slurm_accounts: ListUniqueNonEmptyString | None = None
    project_dir: AbsolutePathStr | None = None

    @field_validator("project_dir", mode="after")
    @classmethod
    def validate_project_dir(cls, value):
        if value is not None:
            validate_cmd(value)
        return value

UserUpdate

Bases: BaseUserUpdate

Schema for User update.

Attributes:

Name Type Description
username NonEmptyStr
Source code in fractal_server/app/schemas/user.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
class UserUpdate(schemas.BaseUserUpdate):
    """
    Schema for `User` update.

    Attributes:
        username:
    """

    model_config = ConfigDict(extra="forbid")
    username: NonEmptyStr = None
    password: NonEmptyStr = None
    email: EmailStr = None
    is_active: bool = None
    is_superuser: bool = None
    is_verified: bool = None

UserUpdateGroups

Bases: BaseModel

Schema for POST /auth/users/{user_id}/set-groups/

Source code in fractal_server/app/schemas/user.py 
85
86
87
88
89
90
91
92
93
class UserUpdateGroups(BaseModel):
    """
    Schema for `POST /auth/users/{user_id}/set-groups/`

    """

    model_config = ConfigDict(extra="forbid")

    group_ids: ListUniqueNonNegativeInt = Field(min_length=1)