Skip to content

user

OAuthAccountRead

Bases: BaseModel

Schema for storing essential OAuthAccount information within UserRead.oauth_accounts.

Attributes:

Name Type Description
id int

ID of the row in fractal-owned oauthaccount table.
account_email str

Email associated to OAuth account
oauth_name str

Name of the OAuth provider (e.g. github)
Source code in fractal_server/app/schemas/user.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class OAuthAccountRead(BaseModel):
    """
    Schema for storing essential `OAuthAccount` information within
    `UserRead.oauth_accounts`.

    Attributes:
        id: ID of the row in fractal-owned `oauthaccount` table.
        account_email: Email associated to OAuth account
        oauth_name: Name of the OAuth provider (e.g. `github`)
    """

    id: int
    account_email: str
    oauth_name: str

UserCreate

Bases: BaseUserCreate

Schema for User creation.

Attributes:

Name Type Description
username Optional[str]
Source code in fractal_server/app/schemas/user.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
class UserCreate(schemas.BaseUserCreate):
    """
    Schema for `User` creation.

    Attributes:
        username:
    """

    username: Optional[str] = None

    # Validators

    _username = field_validator("username")(classmethod(valstr("username")))

UserRead

Bases: BaseUser[int]

Schema for User read from database.

Attributes:

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

    Attributes:
        username:
    """

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

UserUpdate

Bases: BaseUserUpdate

Schema for User update.

Attributes:

Name Type Description
username Optional[str]
Source code in fractal_server/app/schemas/user.py 
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
class UserUpdate(schemas.BaseUserUpdate):
    """
    Schema for `User` update.

    Attributes:
        username:
    """

    model_config = ConfigDict(extra="forbid")

    username: Optional[str] = None

    # Validators
    _username = field_validator("username")(classmethod(valstr("username")))

    @field_validator(
        "is_active",
        "is_verified",
        "is_superuser",
        "email",
        "password",
    )
    @classmethod
    def cant_set_none(cls, v, info: ValidationInfo):
        if v is None:
            raise ValueError(f"Cannot set {info.field_name}=None")
        return v

UserUpdateGroups

Bases: BaseModel

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

Source code in fractal_server/app/schemas/user.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
class UserUpdateGroups(BaseModel):
    """
    Schema for `POST /auth/users/{user_id}/set-groups/`

    """

    model_config = ConfigDict(extra="forbid")

    group_ids: list[int] = Field(min_length=1)

    _group_ids = field_validator("group_ids")(
        classmethod(val_unique_list("group_ids"))
    )

UserUpdateStrict

Bases: BaseModel

Schema for User self-editing.

Attributes:

Source code in fractal_server/app/schemas/user.py 
79
80
81
82
83
84
85
86
class UserUpdateStrict(BaseModel):
    """
    Schema for `User` self-editing.

    Attributes:
    """

    model_config = ConfigDict(extra="forbid")