viam.proto.app.end_user
=======================

.. py:module:: viam.proto.app.end_user

.. autoapi-nested-parse::

   @generated by Viam.
   Do not edit manually!



Classes
-------

.. autoapisummary::

   viam.proto.app.end_user.EndUserServiceBase
   viam.proto.app.end_user.EndUserServiceStub
   viam.proto.app.end_user.UnimplementedEndUserServiceBase
   viam.proto.app.end_user.AcceptLegalRequest
   viam.proto.app.end_user.AcceptLegalResponse
   viam.proto.app.end_user.GetAuthApplicationRequest
   viam.proto.app.end_user.GetAuthApplicationResponse
   viam.proto.app.end_user.IsLegalAcceptedRequest
   viam.proto.app.end_user.IsLegalAcceptedResponse
   viam.proto.app.end_user.RegisterAuthApplicationRequest
   viam.proto.app.end_user.RegisterAuthApplicationResponse
   viam.proto.app.end_user.UpdateAuthApplicationRequest
   viam.proto.app.end_user.UpdateAuthApplicationResponse


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

.. py:class:: EndUserServiceBase

   Bases: :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: IsLegalAccepted(stream: grpclib.server.Stream[app.v1.end_user_pb2.IsLegalAcceptedRequest, app.v1.end_user_pb2.IsLegalAcceptedResponse]) -> None
      :abstractmethod:

      :async:



   .. py:method:: AcceptLegal(stream: grpclib.server.Stream[app.v1.end_user_pb2.AcceptLegalRequest, app.v1.end_user_pb2.AcceptLegalResponse]) -> None
      :abstractmethod:

      :async:



   .. py:method:: RegisterAuthApplication(stream: grpclib.server.Stream[app.v1.end_user_pb2.RegisterAuthApplicationRequest, app.v1.end_user_pb2.RegisterAuthApplicationResponse]) -> None
      :abstractmethod:

      :async:



   .. py:method:: UpdateAuthApplication(stream: grpclib.server.Stream[app.v1.end_user_pb2.UpdateAuthApplicationRequest, app.v1.end_user_pb2.UpdateAuthApplicationResponse]) -> None
      :abstractmethod:

      :async:



   .. py:method:: GetAuthApplication(stream: grpclib.server.Stream[app.v1.end_user_pb2.GetAuthApplicationRequest, app.v1.end_user_pb2.GetAuthApplicationResponse]) -> None
      :abstractmethod:

      :async:



   .. py:method:: __mapping__() -> Dict[str, grpclib.const.Handler]


.. py:class:: EndUserServiceStub(channel: grpclib.client.Channel)

   .. py:attribute:: IsLegalAccepted


   .. py:attribute:: AcceptLegal


   .. py:attribute:: RegisterAuthApplication


   .. py:attribute:: UpdateAuthApplication


   .. py:attribute:: GetAuthApplication


.. py:class:: UnimplementedEndUserServiceBase

   Bases: :py:obj:`EndUserServiceBase`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: IsLegalAccepted(stream: grpclib.server.Stream[app.v1.end_user_pb2.IsLegalAcceptedRequest, app.v1.end_user_pb2.IsLegalAcceptedResponse]) -> None
      :async:



   .. py:method:: AcceptLegal(stream: grpclib.server.Stream[app.v1.end_user_pb2.AcceptLegalRequest, app.v1.end_user_pb2.AcceptLegalResponse]) -> None
      :async:



   .. py:method:: RegisterAuthApplication(stream: grpclib.server.Stream[app.v1.end_user_pb2.RegisterAuthApplicationRequest, app.v1.end_user_pb2.RegisterAuthApplicationResponse]) -> None
      :async:



   .. py:method:: UpdateAuthApplication(stream: grpclib.server.Stream[app.v1.end_user_pb2.UpdateAuthApplicationRequest, app.v1.end_user_pb2.UpdateAuthApplicationResponse]) -> None
      :async:



   .. py:method:: GetAuthApplication(stream: grpclib.server.Stream[app.v1.end_user_pb2.GetAuthApplicationRequest, app.v1.end_user_pb2.GetAuthApplicationResponse]) -> None
      :async:



.. py:class:: AcceptLegalRequest

   Bases: :py:obj:`google.protobuf.message.Message`


   Abstract base class for protocol messages.

   Protocol message classes are almost always generated by the protocol
   compiler.  These generated types subclass Message and implement the methods
   shown below.


.. py:class:: AcceptLegalResponse

   Bases: :py:obj:`google.protobuf.message.Message`


   Abstract base class for protocol messages.

   Protocol message classes are almost always generated by the protocol
   compiler.  These generated types subclass Message and implement the methods
   shown below.


.. py:class:: GetAuthApplicationRequest(*, org_id: str = ..., application_id: str = ...)

   Bases: :py:obj:`google.protobuf.message.Message`


   Abstract base class for protocol messages.

   Protocol message classes are almost always generated by the protocol
   compiler.  These generated types subclass Message and implement the methods
   shown below.


   .. py:attribute:: org_id
      :type:  str


   .. py:attribute:: application_id
      :type:  str


.. py:class:: GetAuthApplicationResponse(*, application_id: str = ..., application_name: str = ..., client_secret: str = ..., origin_uris: collections.abc.Iterable[str] | None = ..., redirect_uris: collections.abc.Iterable[str] | None = ..., logout_uri: str = ...)

   Bases: :py:obj:`google.protobuf.message.Message`


   Abstract base class for protocol messages.

   Protocol message classes are almost always generated by the protocol
   compiler.  These generated types subclass Message and implement the methods
   shown below.


   .. py:attribute:: application_id
      :type:  str


   .. py:attribute:: application_name
      :type:  str


   .. py:attribute:: client_secret
      :type:  str


   .. py:attribute:: logout_uri
      :type:  str


   .. py:property:: origin_uris
      :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]



   .. py:property:: redirect_uris
      :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]



.. py:class:: IsLegalAcceptedRequest

   Bases: :py:obj:`google.protobuf.message.Message`


   Abstract base class for protocol messages.

   Protocol message classes are almost always generated by the protocol
   compiler.  These generated types subclass Message and implement the methods
   shown below.


.. py:class:: IsLegalAcceptedResponse(*, accepted_legal: bool = ...)

   Bases: :py:obj:`google.protobuf.message.Message`


   Abstract base class for protocol messages.

   Protocol message classes are almost always generated by the protocol
   compiler.  These generated types subclass Message and implement the methods
   shown below.


   .. py:attribute:: accepted_legal
      :type:  bool

      If false, the user should not be able to use the application.


.. py:class:: RegisterAuthApplicationRequest(*, application_name: str = ..., org_id: str = ..., origin_uris: collections.abc.Iterable[str] | None = ..., redirect_uris: collections.abc.Iterable[str] | None = ..., logout_uri: str = ...)

   Bases: :py:obj:`google.protobuf.message.Message`


   Abstract base class for protocol messages.

   Protocol message classes are almost always generated by the protocol
   compiler.  These generated types subclass Message and implement the methods
   shown below.


   .. py:attribute:: application_name
      :type:  str


   .. py:attribute:: org_id
      :type:  str


   .. py:attribute:: logout_uri
      :type:  str


   .. py:property:: origin_uris
      :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]



   .. py:property:: redirect_uris
      :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]



.. py:class:: RegisterAuthApplicationResponse(*, application_id: str = ..., application_name: str = ..., client_secret: str = ...)

   Bases: :py:obj:`google.protobuf.message.Message`


   Abstract base class for protocol messages.

   Protocol message classes are almost always generated by the protocol
   compiler.  These generated types subclass Message and implement the methods
   shown below.


   .. py:attribute:: application_id
      :type:  str


   .. py:attribute:: application_name
      :type:  str


   .. py:attribute:: client_secret
      :type:  str


.. py:class:: UpdateAuthApplicationRequest(*, org_id: str = ..., application_id: str = ..., application_name: str = ..., origin_uris: collections.abc.Iterable[str] | None = ..., redirect_uris: collections.abc.Iterable[str] | None = ..., logout_uri: str = ...)

   Bases: :py:obj:`google.protobuf.message.Message`


   Abstract base class for protocol messages.

   Protocol message classes are almost always generated by the protocol
   compiler.  These generated types subclass Message and implement the methods
   shown below.


   .. py:attribute:: org_id
      :type:  str


   .. py:attribute:: application_id
      :type:  str


   .. py:attribute:: application_name
      :type:  str


   .. py:attribute:: logout_uri
      :type:  str


   .. py:property:: origin_uris
      :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]



   .. py:property:: redirect_uris
      :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]



.. py:class:: UpdateAuthApplicationResponse(*, application_id: str = ..., application_name: str = ...)

   Bases: :py:obj:`google.protobuf.message.Message`


   Abstract base class for protocol messages.

   Protocol message classes are almost always generated by the protocol
   compiler.  These generated types subclass Message and implement the methods
   shown below.


   .. py:attribute:: application_id
      :type:  str


   .. py:attribute:: application_name
      :type:  str