schemas
UserCreate
¶
Bases: BaseUserCreate
Schema for User
creation.
Attributes:
Name | Type | Description |
---|---|---|
username |
Optional[str]
|
|
Source code in fractal_server/app/schemas/user.py
93 94 95 96 97 98 99 100 101 102 103 104 105 |
|
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
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
|
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 |
datetime
|
Creation timestamp |
user_ids |
Optional[list[int]]
|
IDs of users of this group |
Source code in fractal_server/app/schemas/user_group.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
|
UserGroupUpdate
¶
Bases: BaseModel
Schema for UserGroup
update
NOTE: new_user_ids
does not correspond to a column of the UserGroup
table, but it is rather used to create new LinkUserGroup
rows.
Attributes:
Name | Type | Description |
---|---|---|
new_user_ids |
list[int]
|
IDs of groups to be associated to user. |
Source code in fractal_server/app/schemas/user_group.py
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
|
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
35 36 37 38 39 40 41 42 43 44 45 |
|
UserSettingsRead
¶
Bases: BaseModel
Schema reserved for superusers
Source code in fractal_server/app/schemas/user_settings.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
|
UserSettingsUpdate
¶
Bases: BaseModel
Schema reserved for superusers
Source code in fractal_server/app/schemas/user_settings.py
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 |
|
UserUpdate
¶
Bases: BaseUserUpdate
Schema for User
update.
Attributes:
Name | Type | Description |
---|---|---|
username |
Optional[str]
|
|
Source code in fractal_server/app/schemas/user.py
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 |
|