:py:mod:`rhino_health.lib.rest_api.rhino_authenticator`
=======================================================

.. py:module:: rhino_health.lib.rest_api.rhino_authenticator


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

Classes
~~~~~~~

.. autoapisummary::

   rhino_health.lib.rest_api.rhino_authenticator.OauthProvider
   rhino_health.lib.rest_api.rhino_authenticator.SSOAuthenticationDetails
   rhino_health.lib.rest_api.rhino_authenticator.UsernamePasswordAuthenticationDetail




Attributes
~~~~~~~~~~

.. autoapisummary::

   rhino_health.lib.rest_api.rhino_authenticator.AuthenticationDetailType


.. py:class:: OauthProvider


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

   


   Which Oauth Provider are you logging in with















   ..
       !! processed by numpydoc !!
   .. py:attribute:: GOOGLE
      :value: 'google'

      

   .. py:attribute:: OKTA
      :value: 'okta'

      


.. py:class:: SSOAuthenticationDetails


   Bases: :py:obj:`typing_extensions.TypedDict`

   


   Dictionary configuration for logging in with SSO















   ..
       !! processed by numpydoc !!
   .. py:attribute:: sso_access_token
      :type: str

      
      The SSO Access Token, required for most SSO Flows
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: sso_id_token
      :type: Optional[str]

      
      The ID Token, optional for certain flows
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: sso_provider
      :type: OauthProvider

      
      Which SSO Provider are you logging in with
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: sso_client
      :type: Optional[str]

      
      Which SSO Client are you logging in with for client provided SSO Integrations
















      ..
          !! processed by numpydoc !!


.. py:class:: UsernamePasswordAuthenticationDetail


   Bases: :py:obj:`typing_extensions.TypedDict`

   


   Dictionary configuration for logging into the platform















   ..
       !! processed by numpydoc !!
   .. py:attribute:: email
      :type: str

      
      The email of the account you are logging in with
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: password
      :type: str

      
      The password of the account you are logging in with, if using password
















      ..
          !! processed by numpydoc !!


.. py:data:: AuthenticationDetailType

   
   Union[SSOAuthenticationDetails, UsernamePasswordAuthenticationDetail]
















   ..
       !! processed by numpydoc !!