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 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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 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

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]

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)

UserUpdateStrict

Bases: BaseModel

Schema for User self-editing.

Attributes:

Source code in fractal_server/app/schemas/user.py 
64
65
66
67
68
69
70
71
class UserUpdateStrict(BaseModel):
    """
    Schema for `User` self-editing.

    Attributes:
    """

    model_config = ConfigDict(extra="forbid")