flip_api.domain.schemas.users

Classes

UserPermissionsResponse	Response model for user permissions.
GetUser	Model for retrieving a user by ID or email.
GetUserByEmail	Model specifically for retrieving a user by email.
GetUserById	Model specifically for retrieving a user by UUID.
Disabled	Model for user disabled status.
UpdateUser	Editable user state.
UpdateUserResponse	Updated user fields.
CognitoUser	Model for Cognito user data.
IRole	Model for role data.
IUser	Model for user data.

Module Contents

class flip_api.domain.schemas.users.UserPermissionsResponse

Bases: pydantic.BaseModel

Response model for user permissions.

permissions: list[str]

class flip_api.domain.schemas.users.GetUser

Bases: pydantic.BaseModel

Model for retrieving a user by ID or email.

userId: str

class flip_api.domain.schemas.users.GetUserByEmail

Bases: GetUser

Model specifically for retrieving a user by email.

userId: pydantic.EmailStr

class flip_api.domain.schemas.users.GetUserById

Bases: GetUser

Model specifically for retrieving a user by UUID.

validate_uuid(v: str) → str

class flip_api.domain.schemas.users.Disabled

Bases: pydantic.BaseModel

Model for user disabled status.

disabled: bool

class flip_api.domain.schemas.users.UpdateUser

Bases: pydantic.BaseModel

Editable user state.

disabled: bool | None = None

name: str | None

organisation: str | None

validate_has_update()

class flip_api.domain.schemas.users.UpdateUserResponse

Bases: pydantic.BaseModel

Updated user fields.

disabled: bool | None = None

name: str | None = None

organisation: str | None = None

class flip_api.domain.schemas.users.CognitoUser

Bases: pydantic.BaseModel

Model for Cognito user data.

id: uuid.UUID

email: pydantic.EmailStr

name: str

organisation: str

is_disabled: bool

model_config

class flip_api.domain.schemas.users.IRole

Bases: pydantic.BaseModel

Model for role data.

id: uuid.UUID

rolename: str

roledescription: str

class flip_api.domain.schemas.users.IUser

Bases: CognitoUser

Model for user data.

roles: list[IRole]