:py:mod:`rhino_health.lib.endpoints.user.user_dataclass`
========================================================

.. py:module:: rhino_health.lib.endpoints.user.user_dataclass


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

Classes
~~~~~~~

.. autoapisummary::

   rhino_health.lib.endpoints.user.user_dataclass.UserWorkgroupRole
   rhino_health.lib.endpoints.user.user_dataclass.User




.. py:class:: UserWorkgroupRole


   Bases: :py:obj:`str`, :py:obj:`enum.Enum`

   
   The role the user has on the platform
















   ..
       !! processed by numpydoc !!
   .. py:attribute:: MEMBER
      :value: 'Member'

      

   .. py:attribute:: WORKGROUP_ADMIN
      :value: 'Workgroup Admin'

      

   .. py:attribute:: ORG_ADMIN
      :value: 'Org Admin'

      

   .. py:attribute:: RHINO_ADMIN
      :value: 'Rhino Admin'

      

   .. py:method:: is_admin_member(member_role) -> bool
      :classmethod:


   .. py:method:: is_non_admin_member(member_role, is_primary_workgroup=False) -> bool
      :classmethod:



.. py:class:: User(**data)


   


   Dataclass representing a User on the Rhino platform.
















   ..
       !! processed by numpydoc !!
   .. py:property:: workgroups
      :type: List[Workgroup]

      

      Return the Workgroup Dataclasses associated with workgroup_uids

      .. warning:: The result of this function is cached.
          Be careful calling this function after making changes.
          All dataclasses must already exist on the platform before making this call.

      :Returns:

          workgroups: List[Workgroup]
              Dataclasses representing the Workgroup



   .. py:property:: primary_workgroup
      :type: Workgroup

      

      Return the Workgroup Dataclass associated with primary_workgroup_uid

      .. warning:: The result of this function is cached.
          Be careful calling this function after making changes.
          All dataclasses must already exist on the platform before making this call.

      :Returns:

          primary_workgroup: Workgroup
              Dataclass representing the Workgroup



   .. py:attribute:: uid
      :type: str

      
       Unique ID of the user
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: full_name
      :type: str

      
       The full name of the user
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: workgroup_uids
      :type: List[str]

      
       Additional workgroup unique IDs the user belongs to
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: primary_workgroup_role
      :type: Optional[UserWorkgroupRole]

      
       Elevated roles the user has in their primary workgroup.
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: workgroup_names
      :type: List[str]

      The workgroup names

   .. py:attribute:: primary_workgroup_name
      :type: str

      The primary_workgroup name