flip_api.domain.schemas.users
=============================

.. py:module:: flip_api.domain.schemas.users


Classes
-------

.. autoapisummary::

   flip_api.domain.schemas.users.UserPermissionsResponse
   flip_api.domain.schemas.users.GetUser
   flip_api.domain.schemas.users.GetUserByEmail
   flip_api.domain.schemas.users.GetUserById
   flip_api.domain.schemas.users.Disabled
   flip_api.domain.schemas.users.CognitoUser
   flip_api.domain.schemas.users.IRole
   flip_api.domain.schemas.users.IUser


Module Contents
---------------

.. py:class:: UserPermissionsResponse

   Bases: :py:obj:`pydantic.BaseModel`


   Response model for user permissions.


   .. py:attribute:: permissions
      :type:  list[str]


.. py:class:: GetUser

   Bases: :py:obj:`pydantic.BaseModel`


   Model for retrieving a user by ID or email.


   .. py:attribute:: userId
      :type:  str


.. py:class:: GetUserByEmail

   Bases: :py:obj:`GetUser`


   Model specifically for retrieving a user by email.


   .. py:attribute:: userId
      :type:  pydantic.EmailStr


.. py:class:: GetUserById

   Bases: :py:obj:`GetUser`


   Model specifically for retrieving a user by UUID.


   .. py:method:: validate_uuid(v)


.. py:class:: Disabled

   Bases: :py:obj:`pydantic.BaseModel`


   Model for user disabled status.


   .. py:attribute:: disabled
      :type:  bool


.. py:class:: CognitoUser

   Bases: :py:obj:`pydantic.BaseModel`


   Model for Cognito user data.


   .. py:attribute:: id
      :type:  uuid.UUID


   .. py:attribute:: email
      :type:  pydantic.EmailStr


   .. py:attribute:: is_disabled
      :type:  bool


   .. py:attribute:: model_config


.. py:class:: IRole

   Bases: :py:obj:`pydantic.BaseModel`


   Model for role data.


   .. py:attribute:: id
      :type:  uuid.UUID


   .. py:attribute:: rolename
      :type:  str


   .. py:attribute:: roledescription
      :type:  str


.. py:class:: IUser

   Bases: :py:obj:`CognitoUser`


   Model for user data.


   .. py:attribute:: roles
      :type:  list[IRole]