From 0e2233d32aff7a0a27184ea55d70f89b65f2a1a2 Mon Sep 17 00:00:00 2001 From: FileMagic <22534836+FileMagic@users.noreply.github.com> Date: Thu, 26 Sep 2024 15:53:30 -0400 Subject: [PATCH] Update sensors.rst to add blurb on get_user_info --- docs/source/sensors.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/source/sensors.rst b/docs/source/sensors.rst index 91170235..63a41075 100644 --- a/docs/source/sensors.rst +++ b/docs/source/sensors.rst @@ -128,6 +128,18 @@ For example: self._logger = self.sensor_service.get_logger(name=self.__class__.__name__) self._logger.debug('Polling 3rd party system for information') +2. get_user_info(name) +~~~~~~~~~~~~~~~~~~~ + +This method allows the sensor instance to retrieve the user can retrieve information +about the user account which is used to perform datastore operations. + +For example: + +.. code-block:: python + + username_info = self.sensor_service.get_user_info() + .. _ref-sensors-datastore-management-operations: Datastore Management Operations