:py:mod:`rhino_health.lib.rhino_session`
========================================

.. py:module:: rhino_health.lib.rhino_session


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

Classes
~~~~~~~

.. autoapisummary::

   rhino_health.lib.rhino_session.RhinoSession




.. py:class:: RhinoSession(authentication_details: Optional[rhino_health.lib.rest_api.rhino_authenticator.AuthenticationDetailType] = None, otp_code: Optional[str] = None, rhino_api_url: str = ApiEnvironment.PROD_API_URL, sdk_version: str = SDKVersion.PREVIEW, show_traceback: bool = False)


   Bases: :py:obj:`rhino_health.lib.rhino_client.RhinoClient`

   
   Allows access to various endpoints directly from the RhinoSession










   .. seealso::

       
       :obj:`rhino_health.lib.endpoints.code_object.code_object_endpoints`
           Available code_object endpoints
       :obj:`rhino_health.lib.endpoints.code_run.code_run_endpoints`
           Available code_run endpoints
       :obj:`rhino_health.lib.endpoints.dataset.dataset_endpoints`
           Available dataset endpoints
       :obj:`rhino_health.lib.endpoints.data_schema.data_schema_endpoints`
           Available data_schema endpoints
       :obj:`rhino_health.lib.endpoints.project.project_endpoints`
           Available project endpoints
       :obj:`rhino_health.lib.endpoints.sql_query.sql_query_endpoints`
           Available sql_query endpoints
       :obj:`rhino_health.lib.endpoints.user.user_endpoints`
           Available user endpoints
       :obj:`rhino_health.lib.endpoints.workgroup.workgroup_endpoints`
           Available workgroup endpoints
       
       


   .. rubric:: Examples

   >>> session.project.get_projects()
   array[Project...]
   >>> session.dataset.get_dataset(my_dataset_uid)
   Dataset

   :Attributes:

       **code_object: Access endpoints at the code_object level**
           ..

       **code_run: Access endpoints at the code_run level**
           ..

       **dataset: Access endpoints at the dataset level**
           ..

       **data_schema: Access endpoints at the data_schema level**
           ..

       **federated_dataset: Access endpoints for federated_datasets**
           ..

       **project: Access endpoints at the project level**
           ..

       **sql_query: Access endpoints for sql queries**
           ..

       **user: Access endpoints at the user level**
           ..

       **workgroup: Access endpoints at the workgroup level**
           ..


   ..
       !! processed by numpydoc !!
   .. py:property:: current_user

      
      Returns the logged in user
















      ..
          !! processed by numpydoc !!

   .. py:method:: switch_user(authentication_details, otp_code=None)

      
      Switch the currently logged in user.


      :Parameters:

          **authentication_details: AuthenticationDetailType**
              A dictionary containing authentication details

          **otp_code: Optional[str]**
              2FA login code if 2FA is enabled for the account








      .. seealso::

          
          :obj:`rhino_health.lib.rest_api.rhino_authenticator.AuthenticationDetailType`
              AuthenticationDetailType
          
          





      ..
          !! processed by numpydoc !!