.. _step-QueryAndCacheSLUsers:


QueryAndCacheSLUsers
====================

Queries a Skylar One instance for all available Users and saves the data to cache with the specified Skylar One ID

.. versionadded:: 1.5.4

* **Friendly name:** ``Query and Cache Skylar One User info``
* **Step class:** ``base_steps_syncpack.steps.QueryAndCacheSLUsers.QueryAndCacheSLUsers``
* **Step version:** ``2.0.1``
* **Required parameters:** ``region``, ``prefix_url``

Parameters
----------

.. list-table::
   :header-rows: 1
   :widths: 22 16 8 16 38

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``region``
     - string
     - yes
     - ``ScienceLogicRegion``
     - The unique identifier for each SL1, PowerFlow, and third party software combination

Required inherited parameters
-----------------------------

These are defined on :ref:`step-GQLRequest` but are **required** here, so a
working configuration must set them.

.. list-table::
   :header-rows: 1
   :widths: 22 16 8 16 38

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``prefix_url``
     - string
     - yes
     - --
     - used with relative_url to create the full URL. Example: ``http://host.example.com``

Other inherited parameters
--------------------------

This step also accepts 39 optional parameter(s) inherited from
:ref:`step-GQLRequest`.

Every step also accepts the platform parameters common to all steps --
see :ref:`platform-parameters`.

Dependencies
------------

* **Inherits from:** ``QueryAndCacheSLUsers`` -> ``GQLRequest`` -> ``HTTPBaseStep`` -> ``BaseStep`` -> ``Serializable``
* **SyncPack modules:** ``base_steps_syncpack.steps.GQLRequest``, ``base_steps_syncpack.util.helpers``, ``base_steps_syncpack.util.request_params``
* **External packages:** ``ipaascommon``

.. include:: /_step_notes/QueryAndCacheSLUsers.rst